asciidoc 超簡易 Cheatseet


軽量マークアップ言語で、リッチな Markdown と言うと伝わりやすいでしょうか。 Github でもプロジェクトルートに README.adoc を置けば、 README.md と同じように表示されます。

ヘッダ

=で書くのが楽です。Markdownの#と同じです。テキストの下部に =====-----で装飾することもできます。

f:id:Naotsugu:20150212234710p:plain

パラグラフ

.から始めるとオプショナルヘッダになります。続くマークアップにより表示のされ方は変わってきます。以下はNOTE:と組み合わせた例です。

f:id:Naotsugu:20150212234723p:plain

IMPORTANT:WARNING:で適したパラグラフになります。

ブロック

----で囲うとブロックになります。コードブロックも以下の通り。****でサイドバーブロック、=====で Exampleブロックになります。

f:id:Naotsugu:20150212234732p:plain

リスト

リストは以下の通り*を使います。順序付きは.

f:id:Naotsugu:20150212234742p:plain

テーブル

2つめの例のように各列を分割して書くこともできます。

f:id:Naotsugu:20150212234755p:plain

リンク

[[ ]] でアンカー定義して、<<>> で参照などなど。

f:id:Naotsugu:20150212234801p:plain

テキスト

_でイタリック、* でボールド とか、’’’’ で罫線とか、コメントにしたりとか。

f:id:Naotsugu:20150213002300p:plain

エディタ

Markdown に比べてエディタが少ないですが、Atom が良いです。

パッケージの導入は、メニューから Atom - Install Shell Commands ととしてシェルコマンドインストールした後、

適当なターミナル開いて、コマンドラインから

$ apm install asciidoc-preview

として再起動すればこんな感じでインストールできます。

f:id:Naotsugu:20150213001203p:plain

Packages メニューから選択して良いasciidocライフを。