使用字符串渲染Markdown代碼示例（JSDoc2MD）

我在JS文件中使用JSDoc註釋並運行JSDoc2MD將這些註釋渲染爲markdown readme.md文件。我想在我的文檔中使用來自JSDoc的@example tag包含代碼示例。我在渲染帶引號的字符串時遇到了問題。使用字符串渲染Markdown代碼示例（JSDoc2MD）

在我JS的意見，我有：

/** @example 
* // returns true 
* yesNo("Do you like cheese?"); 
*/

這一評論成爲JSON如下：

{ 
"examples": [ 
     "// returns true\nyesNo(\"Do you like cheese?\");" 
    ] 
}

我有JSDoc2MD用來生成自述自定義模板車把安裝。在我的車把模板，我有：

```js 
{{#each examples}} 
{{this}} 
{{/each}} 
```

生成的自述有HTML名稱，而不是引號：

```js 

// returns true 
yesNo(&quot;Do you like cheese?&quot;); 

```

所以降價輸出看起來不錯期待引號：

// returns true 
yesNo(&quot;Do you like cheese?&quot;);

任何其他人使用JSDoc2MD有這個問題？我在這裏輸錯了什麼嗎？

來源

2016-02-12 Sara

什麼問題？ HTML實體在瀏覽器中顯示爲引號。實際上，一些Markdown實現會將各種字符轉換爲它們的HTML實體。 – Waylan

And [most]（http://johnmacfarlane.net/babelmark2/?normalize=1&text=yesNo（％26quot％3BDo + you + like + cheese％3F％26quot％3B）％3B）Markdown實現通過不變地傳遞HTML實體。順便說一下，使用「預覽」選項卡查看瀏覽器正確顯示內容。 – Waylan

這是一個車把東西，試試這個：

```js 
{{#each examples}} 
{{{this}}} 
{{/each}} 
```

注意三倍括號this ..看到here並查找「三重藏匿」。

來源

2016-02-13 20:47:00 Lloyd

正是我需要的。謝謝勞埃德。 – Sara

使用字符串渲染Markdown代碼示例（JSDoc2MD）

回答

相關問題