From f27e488dcda61b56a3308d8b0d5c7516b3677665 Mon Sep 17 00:00:00 2001 From: Takumi Sueda Date: Sun, 18 Oct 2020 04:00:07 +0900 Subject: [PATCH] Describe how to write wiki --- Wikiの管理.md | 30 ++++++++++++++++++++++++++++++ _Sidebar.md | 1 + 2 files changed, 31 insertions(+) create mode 100644 Wikiの管理.md diff --git a/Wikiの管理.md b/Wikiの管理.md new file mode 100644 index 0000000..0bd9ec9 --- /dev/null +++ b/Wikiの管理.md @@ -0,0 +1,30 @@ +# 準備 + +依存ライブラリをインストールする。 + +```sh +$ npm install -g doctoc +$ pip3 install markdown +``` + +WikiをCloneする。 + +```sh +$ git clone https://github.com/brain-hackers/README.wiki.git +``` + + +# ファイル名とサイドバーの関係 + +サイドバーの目次は `generate_toc.py` でWiki repositoryのファイル名から自動生成している。 + +ファイル名に ` > `(前後のスペース必須)が含まれていると、その左側はセクション名と解釈される。 + +例えば、ページ `あ > か.md` は大見出し `あ` の下に箇条書きで `か` として描画される。 + +`あ > い.md` と `あ > い > う.md` は同時に存在できない。 `い` が単一のページなのかセクション名なのか区別できないからである。 + +` > ` はファイル名の中で2回まで使える。 `あ.md` や `あ > い > う.md` は valid だが、 `あ > い > う > え.md` は invalid となる。 + +ページ名にハイフン `-` (Hyphen-Minus, U+002D) を使いたい場合、そのままファイル名に入れるとページ名ではスペース扱いになってしまう。これを回避するために、よく似た別なUnicode文字 `‐` (Hyphen, U+2010) を使う。 + diff --git a/_Sidebar.md b/_Sidebar.md index 79a0154..3b8e07c 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -2,6 +2,7 @@ [Home](Home) + - [Wikiの管理](Wiki%E3%81%AE%E7%AE%A1%E7%90%86) # Linux - [ビルド](Linux---%E3%83%93%E3%83%AB%E3%83%89) # U‐Boot