OSS のドキュメントをどうやって公開すべきか

[suzuki-shunsuke]

• GitHub で Markdown
• GitHub Pages
  • Hugo
  • https://docusaurus.io/
  • Sphinx: https://www.sphinx-doc.org/ja/master/
  • https://github.com/honkit/honkit
  • https://www.mkdocs.org/
  • https://docsify.js.org/#/
• GitBook: https://www.gitbook.com/
• Read the Docs: https://readthedocs.org/

[suzuki-shunsuke]

aqua のドキュメントを GitBook に sync してみているが、ちょっとこれじゃない感が強い。 単なる静的 web site をホスティングするサービスではない。 認知不可が高そう。

GitHub の Markdown はいわばそのままなので特に考えること・覚えることがないが、それに対して無駄に難しい気がする。

別にコラボレーションとかドキュメントの権限管理がしたいわけではない。

[suzuki-shunsuke]

GitHub Pages はドメインどうするかという問題がある。 自分の User Page のドメインが techblog.szksh.cloud になっている。

[suzuki-shunsuke]

Docusaurus 2 が良い感じということで Close