AsciiDocの簡単な書き方のまとめ。詳しい書き方はユーザーマニュアルなど参照のこと。このページはCheatseetのページをさらに適当に要約した。
章は
Level 1 ------- Level 2 ~~~~~~~ Level 3 ^^^^^^^ Level 4 +++++++
と書くが、文字数と下線の文字数が一致してないといけないので、日本語ではあまりよろしくしない。他にも
== Level 1 === Level 2 ==== Level 3 ===== Level 4
のような書き方ができるので、これを使うのがよい。
頭に.をつけるとタイトルが付く。
.一行のパラグラグ NOTE: 一行パラグラフのサンプル。 .複数行のパラグラフ [NOTE] 複数行のパラグラフの サンプル。
パラグラフの種類は、NOTE, TIP, IMPORTANT, WARNING, CAUTION がある。
---- コード、ファイルリストなどのリスト ----
サイドバーブロックって何？
**** サイドバーブロック ****
他に
=================================== Example Block ===================================
で囲うブロックもある。
コメント
//// コメントブロック ////
書体は*などで囲うだけである。
normal, _italic_, *bold*, +mono+ ``double quoted'', `single quoted' normal, ^super^, ~sub~
[前景色,背景色,サイズ]#テキスト#
みたいに書く。
[red]#red text# [,yellow]#on yellow# [,,2]#large# [red,yellow,2]*all bold*
(C) (R) (TM) -- ... -> <- => <= ¶
もそれぞれ三点リーダーや矢印になるらしい。まあ使わんかな。
[[anchor-1]]
でアンカー埋め込み
アンカーへのリンクは
<<anchor-1>> <<anchor-1,アンカーへのリンク>> xref:anchor-1[]
link:リンク先[]
行内に埋め込む画像は
image:images/icons/home.png[]
ブロックイメージは
image::images/icons/home.png[]
みたいな。
画像のフォーマットはHTML,PDFで使うなら、PNG, JPEGのみ。
image::images/tiger.png[align="left"]
みたいに左寄せ右寄せできる。画像を置くディレクトリは基本的には カレントディレクトリらしいが、-a iconsdir=<path> -a imagesdir=<path> で指定することもできるようだ。
.An example table [options="header,footer"] |======================= |Col 1|Col 2 |Col 3 |1 |Item 1 |a |2 |Item 2 |b |3 |Item 3 |c |6 |Three items|d |=======================
カンマ区切りのもできるらしい。 [format="csv",width="60%",cols="4"] [frame="topbot",grid="none"] |====== 1,2,3,4 a,b,c,d A,B,C,D |======
テーブルの作り方は複雑なので、マニュアル参照！
箇条書きは*、番号つけるのは.で、それぞれの記号に続けて半角スペースで書く。
* りんご * みかん ** オレンジ ** いよかん * オレンジ
↑これは箇条書き
. 大阪 . 天満 . 桜ノ宮
↑これは数字が付く
include::sometext.txt[]