ClojureScript

編輯

本頁涵蓋了在此網站上撰寫內容時有用的 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 中有很多方法可以處理跳脫字元,但其中最有幫助的方法之一是使用以下方式省略所有格式

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 資源,可以回答更進階的問題。