かきスタンプ

福岡でフリーランスの物流系のエンジニアやってます。

MkDocs:インストールから github pages へのデプロイまで

MkDocsという、静的ページをサクッと作る事が出来るツールがあります。
以下、インストールから、GitHub Pagesまでアップロードする手順です。
 
githubのアカウントを「kakisoft」、githubリポジトリを「sample01」という名称でやってます。
必要に応じて、適宜読み替えてください。  

MKDocs をインストール(Windows の場合)

Chocolatey(パッケージマネージャー) を使用しています。
Chocolateyのインストールはこんな感じです。

choco install pip
pip install mkdocs

power shellでは上手く行かなかったんで、他の適当なコンソースアプリを使用してください。
私は、Cmderを愛用しています。

MKDocs をインストール(Cent OS の場合)

sudo yum install python-pip
sudo pip install pip --upgrade
sudo pip install mkdocs

MKDocs をインストール(Mac の場合)

sudo easy_install pip
sudo pip install pip --upgrade
sudo pip install mkdocs

sudo pip install mkdocs-windmill

ひな形を作成

mkdocs new sample01
cd sample01
mkdocs build
mkdocs serve

http://127.0.0.1:8000/ にアクセスすると、こんなページが表示されます。
f:id:kakisoft:20190831153745p:plain  

コンテンツの追加

docs フォルダに、拡張子が「.md」のファイルを追加します。(それ以外の拡張子は対象外となるようです。)
ブラウザのリロード不要で、修正した内容がリアルタイムに反映されます。

GitHub リポジトリに登録

アカウント: kakisoft
リポジトリ: sample01
にアップしています。必要に応じて、読み替えて下さい。
以下では、リポジトリは既に作成済みの状態です。

git init
git add .
git commit -m "first commit"
git push -u origin mastergit remote add origin https://github.com/kakisoft/sample01.git
git pull origin master

デプロイ

mkdocs gh-deploy

URLは、こんな感じになります。
https://kakisoft.github.io/sample01/

アカウント名、リポジトリ名を、適宜読み替えてください。
 
「gh-page」ブランチが自動で作成され、そのブランチが公開用のリポジトリとなります。
うまく表示されない場合、リポジトリの Setting にて、「GitHub Pages」が published となっているか確認してください。
 
f:id:kakisoft:20190831153806p:plain
 

作ったもの

こんなの作ってます。

人狼ゲーム用語集(英語)

https://kakisoft.github.io/WerewolfGameInEnglish/  
 

調べものをして、メモとして残しておきたい事を記録したり。

https://kakisoft.github.io/MiscellaneousDocs/



スポンサーリンク