ドキュメント

ドキュメント管理ツール

• MkDocs
  • Material for MkDocs
• VuePress/Netlify
• HuckMDとGithub連携

MkDocs

• 【年末大掃除】.mdをCI/CDで整理する
  • GitLabでドキュメント作成を自動化
  • 既存のプロジェクトのドキュメントサイトをMkdocsで作ってGitLab Pagesで公開
• git-revision-date-localizedプラグイン
  • 更新日時を表示できる
• GitHub Actions による GitHub Pages への自動デプロイ
  • プッシュしたら自動でデプロイ
• GitHub Actionsを利用したMkDocsの自動デプロイ
  • プッシュしたら自動でデプロイ(上のやつよりもう少し詳しい設定ある)

サンプル集

• MkDocs
  • ドキュメントページ
  • yamlファイル
• OpenFaaS
  • ドキュメントページ
  • yamlファイル
• Keras Document
  • ドキュメントページ
  • yamlファイル
• pymdown extension
  • ドキュメントページ
  • yamlファイル

Github pages

• プロジェクトごとにドキュメントページを生成してgithubにホスティングできる
• リポジトリ名に _ を含むのはだめっぽい