summaryrefslogtreecommitdiff
path: root/doc/content-templates
diff options
context:
space:
mode:
Diffstat (limited to 'doc/content-templates')
-rw-r--r--doc/content-templates/README.md27
-rw-r--r--doc/content-templates/note.md31
-rw-r--r--doc/content-templates/software.md41
3 files changed, 99 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`をコメントのままにする。
diff --git a/doc/content-templates/note.md b/doc/content-templates/note.md
new file mode 100644
index 0000000..8351fe3
--- /dev/null
+++ b/doc/content-templates/note.md
@@ -0,0 +1,31 @@
++++
+# 必須。ページ見出し、一覧、HTML titleで使用する。
+title = "記事タイトル"
+
+# 任意。一覧とmeta descriptionで使用する。不要なら空文字列のままにする。
+description = ""
+
+# 必須。公開日とNotesの並び順で使用する。
+date = 2026-08-22
+
+# 任意。記事を更新したときにコメントを解除し、更新日を指定する。
+# updated = 2026-08-22
+
+[taxonomies]
+# 任意。タグ一覧とタグ別ページで使用する。
+tags = []
+
+[extra]
+# 任意。content/を基準にしたSoftwareのMarkdown pathを指定する。
+related_software = []
++++
+
+導入文を書く。
+
+## 見出し
+
+本文を書く。
+
+## 参考資料
+
+- [資料名](https://example.com/)
diff --git a/doc/content-templates/software.md b/doc/content-templates/software.md
new file mode 100644
index 0000000..56ac280
--- /dev/null
+++ b/doc/content-templates/software.md
@@ -0,0 +1,41 @@
++++
+# 必須。Software名、一覧、HTML titleで使用する。
+title = "software-name"
+
+# 任意。一覧とmeta descriptionで使用する。不要なら空文字列のままにする。
+description = ""
+
+# 必須。Software一覧の並び順で使用する。
+date = 2026-08-22
+
+# 必須。Notes中心のサイトfeedへSoftwareを含めない。
+include_in_feeds = false
+
+[extra]
+# 任意。詳細ページの「使用言語」に表示する。
+language = []
+
+# 任意。詳細ページの「ライセンス」に表示する。
+license = ""
+
+# 必須。ソースコードの正本となるcgit URLを指定する。
+source = "https://git.takashi-2521.com/software-name/"
+
+# 任意。GitHub mirrorがない場合は空文字列のままにする。
+github_mirror = ""
+
+# 任意。content/を基準にしたNotesのMarkdown pathを指定する。
+related_notes = []
++++
+
+## 概要
+
+ソフトウェアの役割と、何ができるものかを書く。
+
+## 背景
+
+解決したかった問題や、制作の目的を書く。
+
+## 開発の過程
+
+設計上の判断、技術選定、実装過程などを書く。