note

Information gathering notes.

Installation

github から clone します。

$ git clone https://github.com/yuyahnd/note.git

環境構築

mkdocs をインストールします。

$ pip install mkdocs
$ pip install mkdocs-material

ドキュメントプロジェクト作成

$ mkdocs new .

以下のようなディレクトリが作成されます。

.
├─ docs/
│  └─ index.md
└─ mkdocs.yml

ローカルサーバー起動

$ mkdocs serve

build

$ mkdocs build

Github Pages deploy

$ mkdocs gh-deploy

License

This repository is licensed under the MIT license. See LICENSE for details.

© 2023 Yuya Honda