タグ

2023年6月24日のブックマーク (1件)

  • MkDocsを触ってみる|fumi

    開発をしているときにたとえ一人であってもプロジェクトが大きくなってくると全てを管理するというのは難しくなります。そこでドキュメントが欲しい!となると思います。今回はドキュメントを生成できるツールの一つであるMkDocsについて紹介します! インストールmkdocs自体はpythonで作られています。ドキュメントツールというだけあって立ち上げ方も簡潔にまとめられているので特に解説はしません。ページの追加からナブバーの追加方法まで書いていてかなり親切な部類に入ると思います。立ち上げ手順のリンク いくつかポイントを書いておきます。 pythonを使う上で仮想環境を入れた後にインストールする事をお勧めします。venvが個人的にお勧めです。 設定についてテーマや設定などデフォルトでは不十分なところがあるので変えていく方が良いと思います。設定は全てmkdocs.ymlの中に書いていきます。(チュートリ

    MkDocsを触ってみる|fumi