在哪里可以找到Rails API rdoc模板

时间:2011-05-05 18:07:55

标签: ruby templates rdoc

我正在尝试使用3.5.3版来美化我的rdoc文档。我不是内置暗鱼主题的粉丝,所以我试图找到一种方法来替换http://api.rubyonrails.org/上官方Rails API文档所使用的方法,但我没有找到它的运气以任何现成的形式。除了其他事情,我还搜遍了github。

到目前为止我发现的是

可能会稍微过时,而且是fork

两者都很好,但不是我想要的。所以在我开始摆弄这些模板之前,有没有人知道Rails API文档使用的模板是否可以作为某个地方的gem使用?

谢谢!

2 个答案:

答案 0 :(得分:3)

这看起来像。忽略说要做gem install horo --pre的说明 - 这实际上会给你一个较旧的测试版。只需执行gem install horo即可获得当前的1.0.3版本(编辑:我发送了拉取请求以更新已接受的指令)。

https://github.com/tenderlove/horo

顺便说一下,我通过查看Rails source code并查看Rakefile来查看RDoc选项,从而找到了这一点。具体而言,第67行显示rdoc.options << '-f' << 'horo'

答案 1 :(得分:3)

我知道这已经很晚了,但看起来Rails的新版本使用了一种名为sdoc的东西,它通过JavaScript搜索增强了输出,并且是一个更清洁的IMO。做一个简单的“gem install sdoc”将得到你需要的东西,然后使用rdoc.options << '-f' << 'sdoc'

github项目似乎位于https://github.com/voloko/sdoc/

顺便说一下,谢谢你的提问!如果没有贴出最初的答案,我就永远都找不到在哪里看了,并且为我自己的项目坚持了那个可怕的暗鱼主题!