6

我已经为 ruby​​ gem 编写了一些使用文档。我正在使用 yard 从 ruby​​ 源代码生成 ruby​​ gem 参考文档,并且我希望 yard 可以使用其他降价文档。

我已经在 gitlab wiki 中编写了文档,它使用与 github 相同的降价,并且所有指向锚点的链接都有效。

当我使用 yard 从标记生成 html 时,出现了两个问题。首先是链接不起作用,因为在降价引用中对其他文件的引用不包含扩展名,例如 [Getting Started] (Introduction#getting-started) 在 wiki 中有效,但 yard 需要 [Getting Started] (Introduction .html#getting-started)。我可以通过在 .htaccess 文件中编写重写规则来解决这个问题。

第二个问题更难。wiki 生成的标题锚点如上,而 yard 锚点是:Introduction.html#Getting_Started

我尝试通过在 .htaccess 文件中添加 [NC] 来解决案例问题,但这没有帮助。另外还有“-”变成“_”的问题。

我的 .yardopts 文件中与我的问题相关的相关位是:

--markup markdown
--markup-provider redcarpet

我的问题是:

生成锚的结构是由于选择了标记还是标记提供者?我对这些术语感到困惑,我无法找到有关它们的有用文档。

我已经安装了 github-markup gem,我尝试用 github-markup 替换 markdown,但没有成功,然后我尝试用 github-markup 替换 redcarpet,但这也不起作用。

我一直在寻找文档以尝试理解我在这里所做的事情,但没有获得任何清晰性,因此抓住了稻草。

4

0 回答 0