6.1 KiB
| title | weight | next | prev |
|---|---|---|---|
| はじめに | 1 | /docs/guide | /docs |
テンプレートからクイックスタート
{{< icon "github" >}} imfing/hextra-starter-template
上記のテンプレートリポジトリを使用して、すぐに始めることができます。
GitHub Actionsワークフローを提供しており、サイトを自動的にビルドしてGitHub Pagesにデプロイし、無料でホストすることができます。 その他のオプションについては、サイトのデプロイを確認してください。
新しいプロジェクトとして始める
HugoプロジェクトにHextraテーマを追加する主な方法は2つあります：
-
Hugoモジュール（推奨）: 最も簡単で推奨される方法です。Hugoモジュールを使用すると、テーマを直接オンラインソースから取り込むことができます。テーマは自動的にダウンロードされ、Hugoによって管理されます。
-
Gitサブモジュール: または、HextraをGitサブモジュールとして追加します。テーマはGitによってダウンロードされ、プロジェクトの
themesフォルダに保存されます。
HugoモジュールとしてHextraをセットアップ
前提条件
開始する前に、以下のソフトウェアがインストールされている必要があります：
手順
{{% 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をセットアップ
前提条件
開始する前に、以下のソフトウェアがインストールされている必要があります：
手順
{{% steps %}}
新しいHugoサイトを初期化
hugo new site my-site --format=yaml
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 %}}
CI/CDを使用してHugoウェブサイトをデプロイする場合、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 >}}