RyoWakabayashi / mkdocs-examples

Exsamples for MkDocs

mkdocs-examples

MkDocs の使用例

実行環境

• Node.js 16.4.1
• Python 3.9.6
• Yarn 1.22.10

asdf がある場合、以下のコマンドでインストール可能

asdf plugin-add nodejs \
    ; asdf plugin-add python \
    ; asdf plugin-add yarn \
    && asdf install

実行方法

依存パッケージのインストール

yarn \
    && pip install --requirement requirements.txt

ローカル環境での起動

mkdocs serve

ブラウザで http://0.0.0.0:8000/ にアクセスする

編集方法

静的解析の自動実行を設定する

pre-commit install

feature ブランチを切り、コミット、プッシュ、プルリクエストを行う