asciidoc:在 Code Fence 内包含粗体
asciidoc: Including bold inside Code Fence
我可以包含在 asciidoc 代码围栏内吗?这是一个示例:
[source,js]
----
function doit() {
*var thing;* // local variable
}
----
我的想法是,出于教学目的,我想突出显示代码块的某些部分。
以上示例无效。
我读过有关使用 [subs="macro"]
之类的东西的信息,但是 (a) 我无法将它与代码围栏结合使用,并且 (b) 文档对实际细节有点不清楚.
谢谢
顺便说一句,我知道一个类似的问题 ,但是没有参考 代码围栏。我已经尝试了解决方案,但在这种情况下不起作用。
在我看来,Asciidoctor 对于这些用例的理念是使用 callouts。
[source,js]
----
function doit() {
var thing; // <1>
}
----
<1> local variable
您应该考虑的第二件事是从真实的、受控的、经过单元测试的文件中提取您的代码。您在此代码文件中定义了一些标记,并在您的 adoc 文件中添加了一个 include
指令。
检查此演示文稿中的幻灯片 15-21:
Writing documentation with Asciidoctor
根据AsciiDocs Documentation,下面的代码
[source,java,subs="verbatim,quotes"]
----
System.out.println("Hello *bold* text").
----
将显示为
System.out.println("Hello bold text").
所以,你需要这个 -
[source,js,subs="verbatim,quotes"]
----
function doit() {
*_var thing;_* // local variable
}
----
会显示为
verbatim
和 quotes
订阅者很有帮助。
注意:
我们需要记住的一件事是代码块已经突出显示了语法。如果你想要不同的格式,最好不要使用代码块。
我可以包含在 asciidoc 代码围栏内吗?这是一个示例:
[source,js]
----
function doit() {
*var thing;* // local variable
}
----
我的想法是,出于教学目的,我想突出显示代码块的某些部分。
以上示例无效。
我读过有关使用 [subs="macro"]
之类的东西的信息,但是 (a) 我无法将它与代码围栏结合使用,并且 (b) 文档对实际细节有点不清楚.
谢谢
顺便说一句,我知道一个类似的问题
在我看来,Asciidoctor 对于这些用例的理念是使用 callouts。
[source,js]
----
function doit() {
var thing; // <1>
}
----
<1> local variable
您应该考虑的第二件事是从真实的、受控的、经过单元测试的文件中提取您的代码。您在此代码文件中定义了一些标记,并在您的 adoc 文件中添加了一个 include
指令。
检查此演示文稿中的幻灯片 15-21: Writing documentation with Asciidoctor
根据AsciiDocs Documentation,下面的代码
[source,java,subs="verbatim,quotes"]
----
System.out.println("Hello *bold* text").
----
将显示为
System.out.println("Hello bold text").
所以,你需要这个 -
[source,js,subs="verbatim,quotes"]
----
function doit() {
*_var thing;_* // local variable
}
----
会显示为
verbatim
和 quotes
订阅者很有帮助。
注意:
我们需要记住的一件事是代码块已经突出显示了语法。如果你想要不同的格式,最好不要使用代码块。