使用yard处理markdown文件

She*_*vin 5 ruby github yard redcarpet

我已经编写了一些使用文档来编写红宝石宝石。我正在使用yard从红宝石源生成红宝石宝石参考文档,并且我希望yard与其他降价文档一起工作。

我已经在gitlab Wiki中编写了文档,该文档使用与github相同的markdown以及锚点的所有链接。

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

第二个问题更难。Wiki生成的标题锚如上所述,而码锚为:Introduction.html#Getting_Started

我尝试通过在.htaccess文件中添加[NC]来解决案例问题,但这无济于事。加上存在将“-”更改为“ _”的问题。

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

--markup markdown
--markup-provider redcarpet
Run Code Online (Sandbox Code Playgroud)

我的问题是:

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

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

我一直在寻找文档以尝试理解我在这里所做的事情,但并不清楚,因此难以理解。