jsduck - JSDuck 指南：如何生成小节导航？

Question

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

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

例如，我的 README.md 文件有一个 H1 头，然后是 5 个 H2 头。假设在每个 H2 标头上方，我放置了一个锚点——例如<a name="h2_1">, <a name="h2_2">,<a name="h2_3">。

我想要标题：（参数）我在 guides.json 中输入的内容出现在页面左侧的 JSDuck 生成的导航中。所以，假设我输入了这些参数：

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

问题是 -section tail - 这是 JSDuck 中的有效链接引用导致解析器无法将 README.md 呈现到目录“foo”中的目标 README.js 中。

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

Answer 1

不幸的是，JSDuck 不支持这一点。它希望 中的每个条目名称都guides.json引用一个目录名称，在该目录名称后面附加“/README.md”，并希望在其中找到指南文件。没有我知道的解决方法，我是这整件事的作者。

整个指南功能充满了各种怪癖和未解决的极端情况。它在很大程度上是 JSDuck 的附加功能。我的主要建议是，当您想做的不仅仅是最基本的指南时，您应该寻找替代解决方案。

或者你可以尝试修补这个。但是我查看了代码，这不是一个简单的修复。