Hugo ドキュメントに貢献する

GitHub ワークフロー

ステップ 1

ドキュメント リポジトリ  をフォークする。

ステップ 2

フォークしたリポジトリをクローンする。

ステップ 3

わかりやすい名前を付けて新しいブランチを作成する。

git checkout -b fix/typos-site-variables

ステップ 4

変更を加える。

ステップ 5

説明的なコミット メッセージ (通常は 50 文字以下) を使用して変更をコミットします。 変更により 1 つ以上の未解決の 問題  が解決される場合は、“Closes” キーワードを含めます。

git commit -m "Fix typos on site variables page

Closes #1234
Closes #5678"

ステップ 6

新しいブランチをドキュメント リポジトリのフォークにプッシュします。

ステップ 7

ドキュメント リポジトリ  にアクセスし、プルリクエスト (PR) を作成します。

ステップ 8

プロジェクトのメンテナがあなたの PR をレビューし、変更を要求するかもしれません。メンテナがあなたの PR をマージした後で、ブランチを削除することもできます。

サンプルコードを含む

フェンス コードブロック

フェンス コードブロックを使用する場合は、以下のように記述言語を含めます。

```go-html-template
{{ if eq $foo "bar" }}
  {{ print "foo is bar" }}
{{ end }}
```

上記のコードは、以下のようにレンダリングされます。

{{ if eq $foo "bar" }}
  {{ print "foo is bar" }}
{{ end }}

code ショートコード

ファイル名とクリップボードへのコピーボタンを含めるには、code ショートコードを使用します。 このショートコードでは、以下のオプションのパラメータを使用できます。

copy

(bool) trueの場合、クリップボードにコピーするボタンを表示しま。デフォルトは true です。

file

(string) 表示するファイル名です。 lang パラメータを指定しない場合、ファイルの拡張子がコード言語を決定します。

lang

(string) コードの言語です。デフォルトは text です。

{{< code file="layouts/_default_/single.html" >}}
{{ if eq $foo "bar" }}
  {{ print "foo is bar" }}
{{ end }}
{{< /code >}}

上記のコードは、以下のようにレンダリングされます。

{{ if eq $foo "bar" }}
  {{ print "foo is bar" }}
{{ end }}

code-toggle ショートコード

code-toggle ショートコードを使用して、サイト構成、フロントマター、またはデータファイルの例を表示します。 このショートコードは、以下のオプションのパラメータを受け付けます。

copy

(bool) true の場合、クリップボードにコピーするボタンを表示します。デフォルトは true です。

file

(string) 表示するファイル名です。サイト構成とデータファイルの例では、ファイル拡張子を省略します。

fm

(bool) true の場合、コードをフロントマターとして表示します。デフォルトは false です。

サイト設定の例

{{< code-toggle file="hugo" >}}
baseURL = 'https://example.org'
languageCode = 'en-US'
title = "Example Site"
{{< /code-toggle >}}

上記のコードは、以下のようにレンダリングされます。

baseURL: https://example.org
languageCode: en-US
title: Example Site

baseURL = 'https://example.org'
languageCode = 'en-US'
title = 'Example Site'

{
   "baseURL": "https://example.org",
   "languageCode": "en-US",
   "title": "Example Site"
}

フロントマターの例

{{< code-toggle file="content/about.md" fm=true >}}
title = "About"
date = 2023-04-02T12:47:24-07:00
draft = false
{{< /code-toggle >}}

上記のコードは、以下のようにレンダリングされます。

---
date: 2023-04-02T12:47:24-07:00
draft: false
title: About
---

+++
date = 2023-04-02T12:47:24-07:00
draft = false
title = 'About'
+++

{
   "date": "2023-04-02T12:47:24-07:00",
   "draft": false,
   "title": "About"
}

アドモニション

コンテンツへの注意を引くには、note ショートコードを使用します。 このショートコードを呼び出すときは、{{% %}} 表記を使用してください。

{{% note %}}
This is **bold** text.
{{% /note %}}

上記のコードは、以下のようにレンダリングされます。