当ドキュメントについて

このドキュメントは、MkDocs-materialを使用して作成されました。

目的

今後の開発の参入障壁を低くするために、どのような技術スタックを利用し、何を目的としているかを示すため。

docs/docsにドキュメントの本体が配置されているため、そちらを編集してください。
また、新たにファイルを追加する場合は、mkdocs.ymlにあるnavに追加してください。

以下のコマンドを実行することで、ローカルでの表示が可能です。

pip install mkdocs-material

cd docs
./start.sh

docs/docsにswaggerをコピーしたのち、以下のコマンドを実行してください。

cd docs
mkdocs serve

GitHub Pagesでの表示は、こちらからご覧いただけます。