summaryrefslogtreecommitdiff
path: root/doc/content-templates/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/content-templates/README.md')
-rw-r--r--doc/content-templates/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/content-templates/README.md b/doc/content-templates/README.md
new file mode 100644
index 0000000..0180943
--- /dev/null
+++ b/doc/content-templates/README.md
@@ -0,0 +1,27 @@
+# コンテンツテンプレート
+
+`content/`へ新しい記事を追加するときに、このディレクトリのMarkdownをコピーして使用する。
+
+| 記事種別 | テンプレート | コピー先 |
+|---|---|---|
+| Notes | `note.md` | `content/notes/<英語ASCIIのslug>.md` |
+| Software | `software.md` | `content/software/<英語ASCIIのslug>.md`、または`content/software/<英語ASCIIのslug>/index.md` |
+
+画像などの記事固有assetがあるSoftwareは、後者のPage Bundle形式を使用し、`index.md`と同じディレクトリへassetを置く。
+
+## 使用手順
+
+1. 対応するテンプレートをコピーする。
+2. Front Matter内の説明コメントを削除する。
+3. 必須項目と日付を実際の値へ置き換える。
+4. 不要な任意項目は空文字列または空配列のまま残せる。
+5. `zola check`で内部リンクとFront Matterを検証する。
+
+関連コンテンツのpathは、`content/`を基準にしたMarkdown pathを指定する。`@/`は付けない。
+
+```toml
+related_software = ["software/example/index.md"]
+related_notes = ["notes/example.md"]
+```
+
+`date`と`updated`はTOMLの日付として記述するため、引用符で囲まない。更新日のないNotesでは、`updated`をコメントのままにする。