コンテンツに進む
Netplan Matsuyama
Blog

PyEhime 20181020 - MkDocs

Netplan Matsuyama
Netplan Matsuyama
Developer

旧サイト記事の移行

ターミナル（シェル環境）

セクション「ターミナル（シェル環境）」
$ env | grep LANG
何も設定されていない場合は、
$ export LANG=ja_JP.UTF-8
としておく。

Python3環境

セクション「Python3環境」

venvをお勧めします。作業用フォルダを workspace とすると、

$ cd workspace
$ python3 -m venv venv
$ source venv/bin/activate

mkdocs インストール

セクション「mkdocs インストール」
$ pip install mkdocs
pip 自体のアップグレードが勧められたら、
$ pip install --upgrade pip

mkdocsのプロジェクト作成

セクション「mkdocsのプロジェクト作成」
$ mkdocs new mktest

ビルド

セクション「ビルド」
$ cd mktest
$ mkdocs serve

ブラウザで http://127.0.0.1:8000 を開く。

カスタマイズ

セクション「カスタマイズ」

いろいろ記事がありますので、適宜試してみてください。 MkDocsによるドキュメント作成 練習で数式を試してみました。 https://kazweda.github.io/mkdocs-lesson/math/

GitHub Pages

セクション「GitHub Pages」

GitHubでリポジトリを作成。mktest git clone の URL(PATH/TO/REPO)を取得

$ git init
$ git remote add origin (PATH/TO/REPO)
$ git pull origin master
$ mkdocs gh-deploy
タグ: