現在目下開発中のCHiLO Book専用作成ツール、"CHiLOBook Producer"のマニュアルを作成しています。
Github内のWikiに作成しているのですが、このWikiは Markdown という記法で書くことができます。
Markdown は軽量マークアップ言語のひとつで、簡潔な記法に則り文章を作成すると、Wiki等のシステムが
自動的にHTMLに変換してくれます。
たとえば以下のように文章を作成すると...
# 見出し1 ## 見出し2 ### 見出し3 あいうえお ## 番号なしリスト * あいうえお * あいうえお * あいうえお ## 番号つきリスト 1. あいうえお 1. あいうえお 1. あいうえお
このような見た目に変換してくれます。
見出しは#を増やすたびに<h1>タグ、<h2>タグ...と小さな見出しになっていきます。
番号つきリストは普通に1.2.3と番号を振っていってもいいのですが、1.1.1.としておくと
自動的に番号を振っていってくれるので、項目の挿入・削除がとても楽です。
テーブルの書き方はというと...
|項目1|項目2| | --- | --- | |セル1|セル2| |セル3|セル4| |セル5|セル6|
結果こうなります。
セルは"|"で構成し、項目の見出しは1個下の行に"---"と入れれば良いわけですね。簡単!
他にも便利な記法が色々ありますが、全体的に書き方が直感的で覚えやすいと感じました。
これはマニュアル作成が捗りますね!