【问题标题】:JSDuck Guides: How to Generate Subsection Navigation?JSDuck 指南:如何生成小节导航?
【发布时间】:2014-11-26 11:41:53
【问题描述】:

我正在使用 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。

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

【问题讨论】:

    标签: jsduck


    【解决方案1】:

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

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

    或者你可以尝试修补它。但我查看了代码,发现这不是一个简单的修复方法。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2019-06-01
      • 2013-01-05
      • 2013-04-13
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多