Clojure

编辑

本页涵盖了在该网站上撰写内容时有用的 Asciidoc 编辑技巧。它并没有涵盖 Asciidoc 的所有功能,只涵盖了在撰写该网站内容时最常遇到的功能。

文件元数据

每个文件都应以如下所示的元数据块开头

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

前几行表示标题、作者和创建日期。最后两行是必要的样板元数据属性。

标题

h2

== h2

h3

=== h3

h4

==== h4

文本标记

标记 效果

_italic_

斜体

*bold*

粗体

_**italic and bold**_

斜体和粗体

`inline code`

行内代码

(C) (R) (TM)

© ® ™

-- ...

 — …​

-> <- => <=

→ ← ⇒ ⇐

要在不改变段落的情况下进行换行,请在行尾添加 +

force +
line break

强制
换行


如果一行中有许多行需要换行,则可以在它们前面添加 [%hardbreaks]

[%hardbreaks]
first line
second line

第一行
第二行


在 Asciidoc 中有许多方法可以处理转义,但其中最有用的一种是使用 *ns* 来省略所有格式

pass:[*ns*]

*ns*

在页面中创建锚点

[[dot]]

链接到另一个内部页面(注意页面后面的 # - 这在我们的生成器中是必需的!)

<<resources#,Resources>>

当前版本的 JBake 中使用的解析器存在一个 bug,该 bug 会导致链接到父目录中的页面出现问题。例如,要链接到 ../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
  • 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 资源,可以帮助您回答更高级的问题。