コンテンツにスキップ

このサイトの作り方

MkDocs(Material テーマ)+ Cloudflare Pages で、Markdown を置くだけで公開されるノートサイトを作った。

30秒で復習

  • MkDocs Material で、Markdown ファイルをそのままWebサイトにしている。
  • GitHub に push すると GitHub Actions が自動でビルドし、Cloudflare Pages に公開する。費用は0円。
  • リポジトリは非公開のまま、できあがったサイトだけを公開している。
  • トップページの「草」と連続日数は、git の履歴から自動で集計している(hooks/dashboard.py)。

メモの書き方

  1. どのページでも右上の 「✏️ 書く」 を押す
  2. GitHub の編集画面が、今日の日付とテンプレート入りで開く
  3. 書いて Commit changes を押すだけ。数分でサイトに反映される

ハードルを下げるルール

  • 1行でもOK。タイトルと「ひとことで」だけで十分
  • きれいにまとめるのは、あとで勉強ノート(テーマ別のページ)に移すとき

構成

notes/
├── mkdocs.yml                    # サイトの設定
├── hooks/dashboard.py            # トップの草・連続日数・最近の更新を作る
├── .github/workflows/deploy.yml  # 自動公開の設定
└── docs/
    ├── index.md                  # トップページ
    ├── memo/posts/               # 備忘録(日付つきの短いメモ)
    └── network-security/ ...     # 勉強ノート(テーマ別)

新しいテーマを増やすとき

  1. docs/ の下にフォルダを作る(例:docs/aws/)
  2. フォルダの中に .nav.yml を作り、title: AWS のようにメニュー名を書く
  3. docs/.nav.yml の nav: にフォルダ名を1行追加する

手元でプレビューする方法

pip install -r requirements.txt
mkdocs serve

公開しないように気をつけること

  • 仕事で知った情報(顧客名、社内の構成、検討中の製品など)
  • パスワード、APIキー、社内URL