【问题标题】:asciidoc: Including bold inside Code Fenceasciidoc:在 Code Fence 中包含粗体
【发布时间】:2016-08-15 23:28:52
【问题描述】:

我可以包含在 asciidoc 代码围栏中吗?这是一个示例:

[source,js]
----
function doit() {
    *var thing;*        //  local variable
}
----

这个想法是为了教学目的,我想突出显示代码块的某些部分。

上面的示例不起作用。

我已经阅读过有关使用 [subs="macro"] 之类的信息,但是 (a) 我无法将它与代码围栏结合使用,并且 (b) 文档对实际细节有点不清楚。

谢谢

顺便说一句,我知道AsciiDoc add bold text inside a listing block 有一个类似的问题,但是没有参考代码围栏。我已经尝试了解决方案,但在这种情况下不起作用。

【问题讨论】:

    标签: asciidoc asciidoctor


    【解决方案1】:

    根据AsciiDocs Documentation,代码如下

    [source,java,subs="verbatim,quotes"] 
    ----
    System.out.println("Hello *bold* text"). 
    ----
    

    将显示为

    System.out.println("你好粗体文本").

    所以,你需要这个 -

    [source,js,subs="verbatim,quotes"]
    ----
    function doit() {
    
        *_var thing;_* //  local variable
    }
    ----
    

    会显示为

    verbatimquotes 订阅者很有帮助。

    注意:
    我们需要记住的一件事是代码块已经突出了语法。如果你想要不同的格式,最好不要使用代码块。

    【讨论】:

    • 感谢您的回答。 (抱歉回复晚了——我之前错过了)。你说得对,语法高亮可能会与其他格式竞争,但我可以解决这个问题。
    【解决方案2】:

    在我看来,Asciidoctor 对于这些用例的理念是使用callouts

    [source,js]
    ----
    function doit() {
        var thing; // <1>
    }
    ----
    <1> local variable
    

    您应该考虑的第二件事是从真实的、受控的、经过单元测试的文件中提取代码。您在此代码文件中定义了一些标记,并在您的 adoc 文件中添加了 include 指令。

    查看此演示文稿中的幻灯片 15-21: Writing documentation with Asciidoctor

    【讨论】:

    • 我也将使用标注,但我特别想使用粗体来突出显示上一个示例的更改。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2015-02-25
    • 1970-01-01
    • 2016-07-05
    • 1970-01-01
    相关资源
    最近更新 更多