site_generator

site_generator は、mdファイルを自動的にhtmlに変換し、github.ioに反映するツールです。

ソースコードの取得

$ git clone https://github.com/cpprefjp/site_generator.git
$ cd site_generator
$ git submodule update -i

ローカルで動作を確認する

まず Docker をインストールする必要があります。

• Macの場合: Docker for Mac をインストール
• Ubuntuの場合: 公式ドキュメント に書いてある通りにコマンドを実行してインストール

cpprefjp の場合

準備:

git clone https://github.com/cpprefjp/site.git cpprefjp/site

# kunai 用のデータを生成する
git clone https://github.com/cpprefjp/kunai.git
cd kunai
git submodule update -i
cd ..
./kunai/docker.sh build
./kunai/docker.sh install
./kunai/docker.sh dist
# 生成した kunai の静的ファイルに対するシンボリックリンクを作る
pushd cpprefjp/static/static
ln -s ../../../kunai/dist kunai
popd

# crsearch 用のデータを生成する
./crsearch.json/docker.sh build
./crsearch.json/docker.sh run
# 生成した crsearch の静的ファイルに対するシンボリックリンクを作る
mkdir -p cpprefjp/static/static/crsearch
pushd cpprefjp/static/static/crsearch
ln -s ../../../../crsearch.json/crsearch.json crsearch.json
popd

# site_generator 用の docker イメージを生成する
./docker.sh build

実行:

# この辺は必要に応じて実行する
(cd cpprefjp/site && git pull)
./crsearch.json/docker.sh run
./kunai/docker.sh run build

./docker.sh run settings.cpprefjp_local
./docker.sh localhost cpprefjp

これでローカルサーバが起動します。 http://localhost:8000 を開けば index.html が表示されます。

run.pyのコマンドライン引数として--prefix=lang/cpp17/のように指定すれば、lang/cpp17/ディレクトリ階層以下のみが変換されます。

boostjp の場合

準備:

git clone https://github.com/boostjp/site.git boostjp/site

# site_generator 用の docker イメージを生成する
./docker.sh build

実行:

./docker.sh run settings.boostjp_local
./docker.sh localhost boostjp

これでローカルサーバが起動します。 http://localhost:8000 を開けば index.html が表示されます。

コーディング規約（開発者向け）

ルールは１つです。 ./docker.sh coding を実行してエラーが出ないようにして下さい。 これはPEP8、Flake8、Hackingあたりの規約を少し緩めて混ぜた規約になっています。