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 中有许多方法可以处理转义,但最有用的一种方法是使用 *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 资源。