From e3f41a8140cfed799a2c977b3d799cd06204b09a Mon Sep 17 00:00:00 2001 From: tanaka takashi Date: Wed, 26 Aug 2026 21:32:11 +0900 Subject: feat: 公開コンテンツとサイト表示を実運用向けに更新 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit サンプル中心だった初期コンテンツを整理し、最初の挨拶Noteとollama-webのSoftware記事、画面キャプチャーを追加する。Aboutとサイト説明はzola.tomlの値を参照する構成に揃え、Software一覧から自前cgitへ案内する。不要になったサンプルNotesとSoftwareは削除する。 ホームの重複する紹介要素を取り除き、見出しサイズ、ページ余白、記事内の見出し間隔、一覧行間を縮小する。bodyとmainをFlexレイアウト化して短いページでもフッターの位置と内側余白を統一し、Software詳細のメタ情報が奇数項目でも罫線と列幅を維持する。 NotesとSoftwareのFront Matterを網羅したコピー用テンプレートと利用手順をdoc/content-templatesへ追加し、設計書と仕様書を現在の構成へ同期する。生成物に加えてdraftディレクトリをGit管理対象外とし、公開前の記事をローカルだけで管理できるようにする。 --- doc/Design.md | 8 +++++++- doc/Specifications.md | 13 +++++++------ doc/content-templates/README.md | 27 ++++++++++++++++++++++++++ doc/content-templates/note.md | 31 +++++++++++++++++++++++++++++ doc/content-templates/software.md | 41 +++++++++++++++++++++++++++++++++++++++ 5 files changed, 113 insertions(+), 7 deletions(-) create mode 100644 doc/content-templates/README.md create mode 100644 doc/content-templates/note.md create mode 100644 doc/content-templates/software.md (limited to 'doc') diff --git a/doc/Design.md b/doc/Design.md index bddd04f..f479e72 100644 --- a/doc/Design.md +++ b/doc/Design.md @@ -285,6 +285,8 @@ Sectionはdate順にする。 #### 6.3.2 Notes Page front matter +新規記事用の完全な雛形は`doc/content-templates/note.md`を使用する。 + ```toml +++ title = "記事タイトル" @@ -348,6 +350,8 @@ Software一覧の順序は初期状態ではdate順とする。 #### 6.4.1 Software Page front matter +新規記事用の完全な雛形は`doc/content-templates/software.md`を使用する。 + ```toml +++ title = "example-software" @@ -537,6 +541,8 @@ Navigationには`aria-label="メインナビゲーション"`を設定する。 Mail addressは設定値に直接埋め込むか、`config.extra`へ置く。 公開時のspam対策を別途必要と判断した場合のみ変更する。 +Footerは全Pageで同じ高さ・内側余白を使用する。Bodyを縦Flex layoutとし、短いPageではFooterをviewport下端へ配置する。Page固有の本文高や`main`の固定最小高でFooter位置を調整しない。 + ### 8.4 Home Template `templates/index.html` @@ -1038,7 +1044,7 @@ body { Sans-serif。 過度な巨大見出しにしない。 -Home H1だけやや大きくする。 +Pageタイトルは本文を圧迫しない控えめな大きさとする。HomeのH1はheading hierarchy維持のため視覚的に非表示とし、サイト名はHeaderだけに表示する。 ### 17.3 Metadata diff --git a/doc/Specifications.md b/doc/Specifications.md index 9f9c60f..1cffd4a 100644 --- a/doc/Specifications.md +++ b/doc/Specifications.md @@ -140,12 +140,13 @@ Homeはサイト全体の入口・索引として機能する。 以下の順序を基本とする。 -1. サイト名 -2. 短い説明文 -3. 最近のNotes -4. Software -5. サイトについての短い説明 -6. Aboutへの導線 +1. 短い説明文 +2. 最近のNotes +3. Software +4. サイトについての短い説明 +5. Aboutへの導線 + +サイト名はHeaderに表示されるため、Home本文では重複表示しない。 ### 5.3 トップ説明文 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 = [] ++++ + +## 概要 + +ソフトウェアの役割と、何ができるものかを書く。 + +## 背景 + +解決したかった問題や、制作の目的を書く。 + +## 開発の過程 + +設計上の判断、技術選定、実装過程などを書く。 -- cgit v1.2.3