Closed7

AsciiDocの自分用チートシート

daifuku-ninjadaifuku-ninja

段落

ドキュメントヘッダ

文頭に=をつける。
ドキュメントヘッダ以下には文書のメタデータを記述できる。

= 文書のタイトル
:Author: 作成者
:Email: <作成者のメールアドレス>
:Revision: 文書のバージョン

ここで記述したメタデータは「属性」として文書中で参照できる。

属性

定義した値を参照できる。

定義
:Author: 作成者
参照
作成者は {author}

大文字小文字は区別されない。

段落

段落と段落の間は1行あける。

改行

行末に+をつける。
もしくは段落の冒頭に[%hardbreaks]と記載すると、文中の改行がそのまま改行として扱われる。

リテラル段落 / リテラルパラグラフ

記述したままを表示する。
1つ以上のスペースを文頭に書く。

daifuku-ninjadaifuku-ninja

段落のヘッダ

レベルの高いヘッダは下線が引かれる。

== レベル 1
内容を書く。

=== レベル 2
内容を書く。

==== レベル 3
内容を書く。

===== レベル 4
内容を書く。

タイトル付きの段落

.行頭にピリオドを書くとタイトル

NOTEなど

[NOTE]
注釈を書く。

[TIP]
補足を書く。

[IMPORTANT]
重要な内容を書く。

[WARNING]
警告を書く。

[CAUTION]
注意ごとを書く。
daifuku-ninjadaifuku-ninja

(コード)ブロック

----
ハイフン4つで囲む。
----

コードブロックにするにはブロック冒頭に言語を明記する。

[source, python]
----
def add():
    print('test.')
----
daifuku-ninjadaifuku-ninja

文字の装飾

 _イタリック_, *ボールド*, +モノ(monospaceフォント)+.

``ダブルクォート'', `シングルクォート'.

 ^上付き^, ~下付き~.

インラインのコードブロック、コメント

`ls -al`

// コメント <- 描画されない
daifuku-ninjadaifuku-ninja

リンク

[[anchor-1]]
アンカー1

anchor:anchor-2[]
アンカー2

<<anchor-1,アンカー1にリンク>>

xref:anchor-2[アンカー2にリンク]

http://google.com[グーグル検索]
daifuku-ninjadaifuku-ninja

リスト

順序なし

- リスト1
  - リスト1-1

- リスト1
- - リスト1-1

* リスト1
  * リスト1-1

* リスト1
* * リスト1-1

順序あり

. リスト1
. リスト2
  .. リスト2-1
  .. リスト2-2
daifuku-ninjadaifuku-ninja

テーブル

[options="header,footer"]
|=================================
|カラム 1|カラム 2      |カラム 3
|1       |アイテム 1    |a
|2       |アイテム 2    |b
|3       |アイテム 3    |c
|合計6   |Three items   |d
|=================================

.データ形式はCSV, 各カラム幅は表示域の15% (60 ÷ 4 = 15)
[format="csv",width="60%",cols="4"]
[frame="topbot",grid="none"]
|======
1,2,3,4
a,b,c,d
A,B,C,D
|======

[grid="rows",format="csv"]
[options="header",cols="^,<,<s,<,>m"]
|===========================
ID,名,姓,住所,電話
1,Vasya,Pupkin,London,+123
2,X,Y,"A,B",45678
|===========================
このスクラップは2022/11/15にクローズされました