Small fixes

Takumi Sueda 2020-10-18 04:08:50 +09:00
parent f5e48eee5c
commit 4dad6f7536
3 changed files with 7 additions and 6 deletions

@ -1,13 +1,9 @@
.PHONY:
install-dependency:
npm install -g doctoc
pip3 install -r requirements.txt
.PHONY:
doctoc:
doctoc --title "### 目次" .
.PHONY:
generate-sidebar:
python3 generate_toc.py
python3 gen_sidebar.py

@ -14,9 +14,14 @@ $ git clone https://github.com/brain-hackers/README.wiki.git
```
# 各文章内の目次生成
各文章内の目次は、[doctoc](https://github.com/thlorenz/doctoc)で生成している。 `make doctoc` で呼ぶことが出来る。
# ファイル名とサイドバーの関係
サイドバーの目次は `generate_toc.py` でWikiに含まれるMarkdown文書のファイル名から自動生成している。
サイドバーの目次はWikiに含まれるMarkdown文書のファイル名から `gen_sidebar.py`自動生成している。 `make generate-sidebar` で呼ぶことが出来る。Wiki に文書を追加する度に実行してコミットする。
ファイル名に ` > `(前後にスペース必須)が含まれていると、その左側はセクション名と解釈される。