mirror of
https://github.com/brain-hackers/README
synced 2025-06-09 22:42:39 +09:00
Describe how to write wiki
parent
49d591077e
commit
f27e488dcd
30
Wikiの管理.md
Normal file
30
Wikiの管理.md
Normal file
@ -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) を使う。
|
||||||
|
|
@ -2,6 +2,7 @@
|
|||||||
|
|
||||||
[Home](Home)
|
[Home](Home)
|
||||||
|
|
||||||
|
- [Wikiの管理](Wiki%E3%81%AE%E7%AE%A1%E7%90%86)
|
||||||
# Linux
|
# Linux
|
||||||
- [ビルド](Linux---%E3%83%93%E3%83%AB%E3%83%89)
|
- [ビルド](Linux---%E3%83%93%E3%83%AB%E3%83%89)
|
||||||
# U‐Boot
|
# U‐Boot
|
||||||
|
Loading…
x
Reference in New Issue
Block a user