記述ルール

md2docsを利用するにはいくつかのルールがあります。

1. h1はドキュメントの先頭で一度だけ記述する

md2docsではh1(例: # title)をページのタイトルとして扱うため、一度しか記述できません。

// NG

# title

# title2

2. ページ単位で分割する場合は<!-- -->を利用する

マークダウン中のセクションをページ単位に分割して出力したい場合は、<!-- -->をセクションの開始位置に記述します。

<!-- -->の中にはページのhtmlファイル名を記述します。例えば下記の例では、page1.htmlを出力します:

<!-- page1 -->

## page1

また、ページ分割を行った場合はh2(例: ## page1)がページタイトルとして扱われます。