2014-10-01 13 views
1

我正在使用JSDuck的Guides功能,其中我在guides.json文件中指定了README.md文件。JSDuck指南:如何生成子部分導航?

我遇到的問題是我無法在guides.json中的README.md文件中指定錨點。

例如,我的README.md文件有一個H1頭,然後是5個H2頭。假設每個H2頭以上,我把錨 - 例如,<a name="h2_1"><a name="h2_2"><a name="h2_3">

我想要的標題:(PARAM)我在guides.json輸入到出現在上JSDuck生成的導航頁面的左側。因此,假設我進入這些參數:

{ 
    name:foo-section-h2_1, 
    title: This is Header2 
} 

的問題是,-section尾巴 - 這是在JSDuck一個有效的鏈接引用導致解析器無法呈現的README.md到目標README.js一個目錄「foo」。

任何人都有任何建議 - 如果無法在指南的主導航欄中表示小節,這是一個巨大的障礙。

回答

0

不幸的是,這不被JSDuck支持。它期望guides.json中的每個條目名稱都引用一個目錄名稱,它附加了「/README.md」,並期望在那裏找到指南文件。沒有我知道的解決方法,而且我是整個事情的作者。

整個導遊功能充滿了各種怪癖和像這樣未解決的角落案例。這對JSDuck來說主要是一個強大的功能。我的主要建議是,當你想要做的不僅僅是最基本的指南,你應該尋找一種替代解決方案。

或者你可以嘗試修補它。但是我看了一下代碼,這不是一個簡單的修復。