hextra/docs/content/docs/getting-started.ja.md

title, weight, tags, next, prev

title	weight	tags	next	prev
はじめに	1	Docs Guide	/docs/guide	/docs

テンプレートから始める

{{< icon "github" >}} imfing/hextra-starter-template

上記のテンプレートリポジトリを使用して、すぐに始めることができます。

GitHub Actions ワークフローを提供しており、サイトを自動的にビルドして GitHub Pages にデプロイし、無料でホストすることができます。 その他のオプションについては、サイトのデプロイを確認してください。

🌐 デモ ↗

新規プロジェクトとして始める

Hugo プロジェクトに Hextra テーマを追加する主な方法は2つあります:

1. Hugo モジュール (推奨): 最も簡単で推奨される方法です。Hugo モジュールを使用すると、テーマをオンラインソースから直接取り込むことができます。テーマは自動的にダウンロードされ、Hugo によって管理されます。

2. Git サブモジュール: または、Hextra を Git サブモジュールとして追加します。テーマは Git によってダウンロードされ、プロジェクトの themes フォルダに保存されます。

Hugo モジュールとして Hextra をセットアップ

前提条件

開始する前に、以下のソフトウェアがインストールされている必要があります:

• Hugo (拡張版)
• Git
• Go

手順

{{% steps %}}

新しい Hugo サイトを初期化

hugo new site my-site --format=yaml

モジュール経由で Hextra テーマを設定

# Hugo モジュールを初期化
cd my-site
hugo mod init github.com/username/my-site

# Hextra テーマを追加
hugo mod get github.com/imfing/hextra

hugo.yaml を設定して Hextra テーマを使用するようにします:

module:
  imports:
    - path: github.com/imfing/hextra

最初のコンテンツページを作成

ホームページとドキュメントページの新しいコンテンツページを作成します:

hugo new content/_index.md
hugo new content/docs/_index.md

ローカルでサイトをプレビュー

hugo server --buildDrafts --disableFastRender

これで、新しいサイトのプレビューが http://localhost:1313/ で利用可能になります。

{{% /steps %}}

{{% details title="テーマを更新するには？" %}}

プロジェクト内のすべての Hugo モジュールを最新バージョンに更新するには、次のコマンドを実行します:

hugo mod get -u

Hextra を最新リリースバージョンに更新するには、次のコマンドを実行します:

hugo mod get -u github.com/imfing/hextra

詳細については、Hugo モジュールを参照してください。

{{% /details %}}

Git サブモジュールとして Hextra をセットアップ

前提条件

開始する前に、以下のソフトウェアがインストールされている必要があります:

• Hugo (拡張版)
• Git

手順

{{% steps %}}

新しい Hugo サイトを初期化

hugo new site my-site --format=yaml

Git サブモジュールとして Hextra テーマを追加

サイトディレクトリに移動して新しい Git リポジトリを初期化します:

cd my-site
git init

次に、Hextra テーマを Git サブモジュールとして追加します:

git submodule add https://github.com/imfing/hextra.git themes/hextra

hugo.yaml を設定して Hextra テーマを使用するようにします:

theme: hextra

最初のコンテンツページを作成

ホームページとドキュメントページの新しいコンテンツページを作成します:

hugo new content/_index.md
hugo new content/docs/_index.md

ローカルでサイトをプレビュー

hugo server --buildDrafts --disableFastRender

新しいサイトのプレビューが http://localhost:1313/ で利用可能になります。

{{% /steps %}}

Hugo ウェブサイトのデプロイに CI/CD を使用する場合、hugo コマンドを実行する前に以下のコマンドを実行することが重要です。

git submodule update --init

このコマンドを実行しないと、テーマフォルダに Hextra テーマファイルが配置されず、ビルドが失敗します。

{{% details title="テーマを更新するには？" %}}

リポジトリ内のすべてのサブモジュールを最新のコミットに更新するには、次のコマンドを実行します:

git submodule update --remote

Hextra を最新のコミットに更新するには、次のコマンドを実行します:

git submodule update --remote themes/hextra

詳細については、Git サブモジュールを参照してください。

{{% /details %}}

次に

以下のセクションを探索して、さらにコンテンツを追加しましょう:

{{< cards >}} {{< card link="../guide/organize-files" title="ファイルの整理" icon="document-duplicate" >}} {{< card link="../guide/configuration" title="設定" icon="adjustments" >}} {{< card link="../guide/markdown" title="Markdown" icon="markdown" >}} {{< /cards >}}