Введение

中文文档 Chinese document

Intro помогает внедрить в ваше приложение на Rails новые функции и предоставляет пошаговое руководство для пользователей.

Intro динамически внедряет код Shepherd.js в ваше приложение, когда пользователь должен увидеть экскурсию по приложению.

• Определите содержание экскурсии за кулисами.
• Содержание экскурсии поддерживает изображения и многоязычность.
• Легко изменить стили экскурсий или добавить тему.
• Хорошо работает с Turbolinks.
• Подходит для не разработчиков.

Пример

Демо

Демо Источник

Установка

Добавьте intro в Gemfile приложения:

gem 'intro'

Затем выполните:

$ bundle install

Скопируйте миграции и конфигурации:

$ rails generate intro:install

После этого выполните миграцию:

$ rails db:migrate

Скомпилируйте активы:

$ rails assets:precompile

Использование

Вставка активов в представление

Вставьте intro_tags в общий макет перед закрывающим тегом body:

<%= intro_tags %>
</body>
</html>

intro_tags импортирует активы intro и добавляет глобальную переменную _intro с параметрами.

Примечание: intro_tags должен быть вставлен в тег body для обновления переменной _intro, если вы хотите использовать Turbolinks.

Добавление экскурсии в закулисье

Посетите http://localhost:3000/intro/admin, чтобы попасть за кулисы после запуска сервера. В файле config/initializers/intro.rb вы можете получить имя пользователя и пароль по умолчанию для входа.

Затем добавьте экскурсию и определите её содержание. После заполнения содержания вам нужно опубликовать экскурсию.

Настройка стиля экскурсии

Если вас не устраивает стиль по умолчанию, вам необходимо запустить генератор ресурсов:

$ rails generate intro:assets

Тогда вы получите файлы ресурсов:

app/javascript/stylesheets/intro/_variables.scss
app/javascript/stylesheets/intro/custom.scss
app/javascript/packs/intro/custom.js

Измените их по своему усмотрению.

Наконец, включите custom_assets в config/initializers/intro.rb, например:

# config/initializers/intro.rb

# override intro tour styles
self.custom_assets = true # or 'intro/custom'

Это добавит ресурсы intro/custom в intro_tags.

Конфигурация intro

Подробнее о конфигурации см. в config/initializers/intro.rb.

Спасибо

• shepherd
• abraham

Содействие

Приветствуются сообщения об ошибках или запросы на вытягивание.

1. Создайте форк.
2. Создайте свою функциональную ветку (git checkout -b my-new-feature).
3. Внесите изменения (git commit -am 'Добавить некоторую функцию').
4. Отправьте изменения в ветку (git push origin my-new-feature).

При необходимости напишите модульный тест для своего кода.

Лицензия

Этот гем доступен как открытый исходный код под условиями MIT License.