0

我已经使用HelpNDoc帮助创作工具完成了我的 rails 页面帮助文档。它生成了一个包含一些 HTML 页面和另外 4 个文件夹(js、img、css 和 lib)的文件夹。我正在寻找将此功能添加到我的 rails 应用程序的最佳方式。

到目前为止,我已经尝试创建一个名为“help”的新控制器并将文件添加到视图文件夹中。之后,我更改了 application.js 和 application.css.scss 文件以添加 js 和 css 文件。原来 HTML 文件包含脚本,所以我将它们放在 help.js 文件中。这看起来是最难的解决方案,因为我必须查看文件来更改引用和其他内容。

有没有其他不涉及改变很多事情的解决方案?

任何帮助表示赞赏。

我的解决方案

我使用了一个引擎(http://guides.rubyonrails.org/engines.html)。我必须编辑 html 文件来修复路线,但这是最干净的解决方案。

4

2 回答 2

0

HelpNDoc 和其他帮助创作工具将生成静态 HTML 内容,包括:HTML、Javascript、CSS 和可能的媒体元素。最好的解决方案是将文档托管在 Rails 应用程序之外,在静态服务器或子域上,例如help.yourapp.com

以下教程可能会帮助您在 Rails 应用程序旁边设置具有静态内容的子域:http ://www.yearofmoo.com/2011/09/serve-precompiled-rails-assets-from-a-static-domain.html

于 2016-01-14T11:13:09.627 回答
0

我建议将 HTML 粘贴为视图,然后通过路由和应用程序链接它

于 2016-01-14T11:22:50.583 回答