編集

このページでは、このサイトにコンテンツを書く際に役立つ Asciidoc 編集のヒントを紹介します。Asciidoc のすべての機能について説明するのではなく、このサイトでコンテンツを書く際に最もよく出てくるものに焦点を当てています。

ファイルメタデータ

すべてのファイルは、次のようなメタデータブロックで始める必要があります。

= Mechanical Computing
Ada Lovelace
2015-12-31
:jbake-type: page
:toc: macro

最初の行は、タイトル、著者、作成日を示します。最後の2行は、必要なボイラープレートメタデータ属性です。

ヘッダー

h2

== h2

h3

=== h3

h4

==== h4

テキストマークアップ

マークアップ効果

マークアップ	効果
_イタリック_	イタリック
太字	太字
_イタリックと太字_	イタリックと太字
`インラインコード`	`インラインコード`
(C) (R) (TM)	© ® ™
-- ...	— …
-> <- => <=	→ ← ⇒ ⇐

_イタリック_

イタリック

*太字*

太字

_**イタリックと太字**_

イタリックと太字

`インラインコード`

インラインコード

-- ...

— …

-> <- => <=

→ ← ⇒ ⇐

段落を変更せずに改行するには、行末に + を追加します

force +
line break

強制
改行

改行が必要な行が複数続く場合は、それらの行の前に [%hardbreaks] を付けることができます

[%hardbreaks]
first line
second line

1行目
2行目

Asciidoc にはエスケープを処理する方法がいくつかありますが、最も役立つのは、次のものを使用することによってすべての書式設定を省略することです

pass:[*ns*]

*ns*

リンク

ページ内にアンカーを作成する

[[dot]]

別の内部ページへのリンク（ページの後ろに # が付いていることに注意してください - これはジェネレーターで必須です！）

<<resources#,Resources>>

リソース

親ディレクトリ内のページへのリンクについては、現在のバージョンの JBake で使用されているパーサーにバグがあります。たとえば、../reference/java_interop.adoc にあるページにリンクするには、次のようなリンクを使用できます。

<<xref/../../reference/java_interop#,Java Interop>>

これは、（架空の）サブディレクトリ xref に移動し、1つ上のディレクトリに戻り、最後に目的のパスをたどります。ここで「xref」の選択は任意ですが、この問題を修正するバージョンがある場合は、後でこれらの上向きのクロスリファレンスをより簡単に見つけて更新できるように、この文字列のみを使用してください。

内部ページ内のアンカーへのリンク

<<resources#books,Books>>

書籍

外部ページへのリンク

https://clojure.github.io/clojure/clojure.core-api.html#clojure.core/defn[defn]

defn

画像

画像は、ページの場所に対応するサブディレクトリ内の assets/images/content ディレクトリに配置する必要があります。

ページ内で次のように画像を参照します

image::/images/content/reference/transducers/xf.png[Nested transformations]

コードブロック

次のように、Clojure形式のコードブロックを挿入できます

[source,clojure]
----
(defn hey
  []
  (println "hey"))
----

(defn hey
  []
  (println "hey"))

テーブル

テーブルは、広範囲なフォーマットオプションを備えたもう1つの大規模なAsciidocトピックです。ただし、これは基本的なテーブルの例です

[options="header"]
|===
| col1 | col2
| a | b
| b | c
|===

col1	col2
a	b
b	c

col1

col2

その他

水平線

''''

目次を挿入します。これは通常、ファイルの先頭で行う必要があります（ページテンプレートはこれを適切に配置します）

toc::[]

その他のリソース

Asciidoc は広範な言語であり、やりたいことは何でもできる方法があるはずです。以下に、より高度な質問に答えるための Asciidoc リソースをいくつか示します。

編集