MkDocsブログ@GitHub Pages構築

#MkDocs #GitHub-Pages

概要

技術書やビジネス本の理解や、すでに世の中の誰かが考察していそうなことのアウトプットをする場がほしかった。
技術的なアウトプットをするプラットフォームはたくさんあるが、すでに世に知れ渡っていることについてはわざわざ発信するのは気が引ける。Qiitaやzennをつかうと、既存の内容をドヤ顔でアウトプットしている感じになる
しかし、理解した内容を自分なりの表現でアウトプットしなおすと、理解が深まるのと、あとからの復習がしやすいメリットがあるので、やりたい。自分はスタディしてこう理解した、という事実だけでもアウトプットしたい。そういう意味で個人ブログがちょうどよかった。
はてなブログなどのブログサービスを利用してもよかったが、自前で構築したほうが管理しやすいし、スタディになる
ただし、VPCやレンタルサーバーなどは使わず、できるだけお金をかけたくない。副業の売上がまだ多くないので、サービスを提供してくれる側には申し訳ないが、利用できるものを活用させてもらう＝GitHub Pagesがちょうどよい

リポジトリ	説明
mkdocs-blog /	MkDocs用のリポジトリ
site -> ngwork0301.github.io	GitHub Pagesとして公開するページをいれるリポジトリ。サブモジュール

MkDocsのbuildコマンドで静的ページを作成するとsiteフォルダができるので、そのsiteフォルダをgitサブモジュールにして、GitHub Pagesのリポジトリにした。
GitHub actionsで、静的ページを生成したあと、git add -Aすれば、公開ページにデプロイされるしくみ
MkDocsにGitHub連携の機能があるので、本来MkDocs用のリポジトリだけでも、公開・管理できる。むしろそのほうが記事をそのままブラウザ上で編集できたり、リポジトリへのリンクを右上に表示させたりできるのでよかったかもしれない。
URLの階層が深くなりそうだったので今回の形になっているが、たぶんそれも対処できるはず。
開発環境->本番環境へデプロイさせる感覚をなんとなく保てたのと、GitHub actionsでデプロイ処理をどう書くのかスタディできて結果的によかったかもしれない。

基本的に以下のページのとおり、やってしまえばできた。感謝。

MkDocsによるドキュメント作成
→ mebiusboxさんのzennの記事。Qiitaに掲載されていたころから一番参照されている印象。
mkdocs を設定する
→ リポジトリが公開されているので大変参考になった。
プロジェクトドキュメント構築向け静的サイトジェネレータ『MkDocs』及び『Material for MkDocs』の個人的導入＆設定まとめ
→ クラスメソッドさんの社内ブログ。クラスメソッド社内でも結構活用されているのだろうか。

Google Analyticsも初めて入れたが、MkDocsの機能で簡単にいれることができた。ただ、cookieを使わない流れの延長でこのままの方法ではダメかもしれない。
NotionユーザとしてはAnotion のようなサービスがあるので迷ったが、お金もかからずいろいろ学べたので、ひとまず満足

最終更新日: May 31, 2021