Clojure

編輯

此頁面涵蓋有助於 Asciidoc 編輯的秘訣,用於撰寫此網站上的內容。它並未涵蓋 Asciidoc 的每個功能,僅涵蓋撰寫此網站上的內容時最常出現的功能。

檔案元資料

每個檔案都應從看起來像這樣的元資料區塊開始

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

第一行表示標題、作者和建立日期。最後兩行是必要的樣板元資料屬性。

標題

h2

== h2

h3

=== h3

h4

==== h4

文字標記

標記 效果

_斜體_

斜體

*粗體*

粗體

_**斜體和粗體**_

斜體和粗體

`內嵌程式碼`

內嵌程式碼

(C) (R) (TM)

© ® ™

-- ...

 — …​

-> <- => <=

→ ← ⇒ ⇐

若要換行而不換段落,請在行尾加上 +

force +
line break

強制
換行


如果您有多行需要換行,可以在行首加上 [%hardbreaks]

[%hardbreaks]
first line
second line

第一行
第二行


Asciidoc 中有許多處理跳脫字元的技巧,其中最實用的一種是使用 *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
  • 第一個

  • 第二個

    • 巢狀

      • 更深入的巢狀

編號清單

. 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
|===
col1 col2

a

b

b

c

其他

水平線

''''

插入目錄,通常應在檔案頂端插入(頁面範本會適當地定位目錄)

toc::[]

更多資源

Asciidoc 是一種廣泛的語言,很可能可以完成您想做的事。以下是更多 Asciidoc 資源,可回答更進階的問題。