このプロジェクトについて

このプロジェクトは、MkDocs で書かれたドキュメントとメモです。 MkDocs は、Markdown で書かれたドキュメントを静的なウェブサイトに変換するpython製のツールです。 ソースコードは、GitHub で管理しており、GitHub Actions で継続的デプロイメントを行っています。 ホスティングは、Netlify で行っています。 今後GitHubのライセンスを有償化した場合は、GitHubPagesでのホスティングを検討しています。

プロジェクトの目的

• 備忘録を目的として技術メモを記録する

プロジェクトの詳細

時間的負荷を軽減しながら、技術メモを記録するために、MkDocsを使用しています。 MkDocsは、Python製の静的サイトジェネレーターで、Markdownで記述されたドキュメントをHTMLに変換します。 デザインも簡単にカスタマイズできるため、技術メモを記録するのに最適です。 プロジェクト内部ではリリースドラフトの自動生成をGitHub Actionsで行っており、リリースタグを打つと自動的にNetlifyにデプロイされます。 これにより、技術メモの更新が簡単になり、また、未完成のメモが公開されることを防ぐことができます。