mirror of
https://github.com/brain-hackers/README
synced 2024-12-22 20:20:03 +09:00
Update delimiter not to include half space
parent
e21b22991a
commit
ba9d2e1afe
10
Wikiの編集方法.md
10
Wikiの編集方法.md
@ -53,12 +53,12 @@ $ git clone https://github.com/brain-hackers/README.wiki.git
|
||||
# ファイル名とサイドバーの関係
|
||||
サイドバーの目次は、Wikiに含まれるMarkdown文書のファイル名から `gen.py` で自動生成しています。 `make finalize` もしくは `make generate` で呼ぶことができます。Wiki に文書を追加するか、ファイル名を変更するたびに実行する必要があります。
|
||||
|
||||
ファイル名に ` > ` **(不等号は全角・前後にスペース必須)** が含まれていると、その左側はセクション名と解釈されます。
|
||||
ファイル名に `>` **(不等号は全角)** が含まれていると、その左側はセクション名と解釈されます。
|
||||
|
||||
例えば、ページ `あ > い.md` は大見出し `あ` の中の `い` というページとして認識されます。
|
||||
例えば、ページ `あ>い.md` は大見出し `あ` の中の `い` というページとして認識されます。
|
||||
|
||||
`あ > い.md` と `あ > い > う.md` は同時に存在できません。 `い` が単一のページなのかセクション名なのか区別できないからです。
|
||||
`あ>い.md` と `あ>い>う.md` は同時に存在できません。 `い` が単一のページなのかセクション名なのか区別できないからです。
|
||||
|
||||
サイドバーの制約から、 ` > ` はファイル名の中で2回まで使えます。 `あ.md` や `あ > い > う.md` は valid ですが、 `あ > い > う > え.md` は invalid です。
|
||||
サイドバーの制約から、 `>` はファイル名の中で2回まで使えます。 `あ.md` や `あ>い>う.md` は valid ですが、 `あ>い>う>え.md` は invalid です。
|
||||
|
||||
ページ名にハイフン `-` (Hyphen-Minus, U+002D) を使いたい場合、GitHub Wiki はハイフンを空白文字と同等に扱うため、そのままファイル名に入れると空白に置き換わって表示されてしまいます。これを回避するために、よく似た別なUnicode文字 `‐` (Hyphen, U+2010) を使ってください(左からコピペして使うと楽)。
|
||||
ページ名にハイフン `-` (Hyphen-Minus, U+002D) を使いたい場合、GitHub Wiki はハイフンを空白文字と同等に扱うため、そのままファイル名に入れると空白に置き換わって表示されてしまいます。これを回避するために、よく似た別なUnicode文字 `‐` (Hyphen, U+2010) を使ってください(左からコピペして使うと楽)。`U‐Boot` をタイトルに含む記事が実際の例です。
|
||||
|
2
gen.py
2
gen.py
@ -12,7 +12,7 @@ def main():
|
||||
if fn.name in {'Home.md', '_Sidebar.md', '_Footer.md'}:
|
||||
continue
|
||||
|
||||
fn_tokens = fn.name[:-3].split(' > ')
|
||||
fn_tokens = fn.name[:-3].split('>')
|
||||
ptr = fn_tree
|
||||
for t in fn_tokens:
|
||||
ptr[t] = ptr.get(t, dict())
|
||||
|
Loading…
Reference in New Issue
Block a user