軽量マークアップ言語で、リッチな Markdown と言うと伝わりやすいでしょうか。 Github でもプロジェクトルートに README.adoc を置けば、 README.md と同じように表示されます。
ヘッダ
=で書くのが楽です。Markdownの#と同じです。テキストの下部に =====や-----で装飾することもできます。
パラグラフ
.から始めるとオプショナルヘッダになります。続くマークアップにより表示のされ方は変わってきます。以下はNOTE:と組み合わせた例です。
IMPORTANT:やWARNING:で適したパラグラフになります。
ブロック
----で囲うとブロックになります。コードブロックも以下の通り。****でサイドバーブロック、=====で Exampleブロックになります。
リスト
リストは以下の通り*を使います。順序付きは.。
テーブル
2つめの例のように各列を分割して書くこともできます。
リンク
[[ ]] でアンカー定義して、<<>> で参照などなど。
テキスト
_でイタリック、* でボールド とか、’’’’ で罫線とか、コメントにしたりとか。
エディタ
Markdown に比べてエディタが少ないですが、Atom が良いです。
パッケージの導入は、メニューから Atom - Install Shell Commands ととしてシェルコマンドインストールした後、
適当なターミナル開いて、コマンドラインから
$ apm install asciidoc-preview
として再起動すればこんな感じでインストールできます。
Packages メニューから選択して良いasciidocライフを。
