2016-08-15 20 views
3

何可以包含在asciidoc代碼圍欄內?這裏是一個樣本:asciidoc:包括加粗的代碼圍欄

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

這個想法是,我想突出代碼塊的某些部分爲教學目的。

上述示例不起作用。

我已閱讀過有關使用類似[subs="macro"]的內容,但(a)我無法將它與代碼圍欄結合使用,並且(b)文檔對實際細節有點不清楚。

感謝

BTW我知道了類似的問題AsciiDoc add bold text inside a listing block的,但有沒有參考代碼柵欄。我已經嘗試瞭解決方案,但在這種情況下不起作用。

回答

1

在我看來,這些用例的Asciidoctor的哲學是使用callouts

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

您應該考慮的第二件事是從真實的,控制的,經過單元測試的文件中提取代碼。您可以在此代碼文件中定義一些標記,並在adoc文件中添加include指令。

檢查幻燈片15-21在此演示文稿: Writing documentation with Asciidoctor

+0

我也會使用標註,但我特別想用粗體突出顯示上一個示例的更改。 – Manngo

1

AsciiDocs Documentation,下面的代碼

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

將顯示爲

的System.out.println(「你好bold text「)。

所以,你需要這個 -

[source,js,subs="verbatim,quotes"] 
---- 
function doit() { 

    *_var thing;_* // local variable 
} 
---- 

enter image description here

verbatimquotes潛艇是有幫助它就會顯示出來。

注意:
有一件事我們需要記住代碼塊已經突出顯示語法。如果你想要不同的格式,最好不要使用代碼塊。