JSDuck指南:如何生成子部分导航?

时间:2014-10-01 15:14:50

标签: jsduck

我正在使用JSDuck的Guides功能,我在guides.json文件中指定了README.md文件。

我遇到的问题是我无法在guides.json中的README.md文件中指定锚点。

例如,我的README.md文件有一个H1 Head,然后有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 tail--它是JSDuck中的有效链接引用导致解析器无法将README.md呈现到目录中的目标README.js中,并且#34; foo&#34;。 / p>

任何人都有任何建议 - 如果不能在指南的主导航中表达小节,那将是一个巨大的障碍。

1 个答案:

答案 0 :(得分:0)

不幸的是,JSDuck不支持。它希望guides.json中的每个条目名称引用一个目录名称,它附加到&#34; /README.md"并期望在那里找到指南文件。我所知道的没有解决方法,而且我是这件事的作者。

整个指南功能充满了各种怪癖和未解决的角落案例。它在很大程度上是JSDuck的一个特殊功能。我的主要建议是,当你想做除最基本指南以外的任何事情时,你应该寻找替代解决方案。

或者您可以尝试修补此功能。但我查看了代码,并不是一个简单的修复方法。