Clojure

編集

このページでは、このサイトのコンテンツ作成のための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でのエスケープ処理方法はいくつかありますが、最も便利な方法の1つは、`*ns*`を使用してすべての書式設定を省略することです。

pass:[*ns*]

*ns*

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

[[dot]]

別の内部ページへのリンク(ページの末尾にある#に注意してください。これはジェネレーターで必要です!)

<<resources#,Resources>>

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

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

これは(架空の)サブディレクトリxrefに移動し、次にディレクトリを戻り、最後に目的のパスに移動します。「xref」の選択は任意ですが、この文字列のみを使用してください。これにより、この問題を修正するバージョンがリリースされた際に、これらの上位クロスリファレンスをより簡単に検索して更新できます。


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

<<resources#books,Books>>

外部ページへのリンク

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

画像

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

ページで画像を参照するには、次のようになります。

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

コードブロック

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

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

リスト

リストを作成するためのオプションは多数あります。ここでは、最も一般的なもののみを示します。

箇条書きリスト

* first
* second
** nested
*** more nested
  • 1つ目

  • 2つ目

    • ネスト

      • さらにネスト

番号付きリスト

. a
. b
.. b.1
... b.1.a
  1. a

  2. b

    1. b.1

      1. b.1.a

混合リスト

* a
. a.1
. a.2
* b
. b.1
. b.2
  • a

    1. a.1

    2. a.2

  • b

    1. b.1

    2. b.2

複数行のリスト項目を作成するには、テキスト書式セクションの改行に関するアドバイスに従ってください。

表は、Asciidocの広範なトピックであり、多くの書式設定オプションがあります。ただし、これは基本的な表の例です。

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

a

b

b

c

その他

水平線

''''

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

toc::[]

その他のリソース

Asciidocは広範な言語であり、やりたいことは何でもできる可能性があります。より高度な質問への回答を得るための、Asciidocのその他のリソースを以下に示します。