Rails лучший способ работы с сторонними сгенерированными html

Я сделал справочную документацию по моей странице рельсов с помощью инструмента создания справки HelpNDoc. Он сгенерировал папку с несколькими HTML-страницами и еще 4 папками (js, img, css и lib). Я ищу лучший способ добавить эту функциональность в мое приложение rails.

До сих пор я пытался создать новый контроллер под названием "помощь" и добавить файлы в папку просмотра. После этого я изменил файлы application.js и application.css.scss, добавив файлы js и css. Оказывается, что файлы HTML содержат скрипты, поэтому я поместил их в файл help.js. Это выглядит как самое сложное решение, так как мне нужно просматривать файлы, чтобы изменить ссылки и другие вещи.

Есть ли другое решение, которое не предполагает изменения многих вещей?

Любая помощь приветствуется.

Мое решение

Я использовал движок ( http://guides.rubyonrails.org/engines.html). Я должен редактировать HTML-файлы, чтобы исправить маршруты, но это самое чистое решение.

2 ответа

Решение

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

Я бы предложил вставить HTML как представление, а затем связать его через маршруты и приложение.

Другие вопросы по тегам