README-CN.md

Intro

Intro 为 Rails 应用添加新功能介绍以及用户指引，她根据用户是否需要功能引导，动态注入了 Shepherd.js 脚本至应用中。Intro 包含以下功能：

• 可在后台中管理用户引导
• 引导内容支持多语言及图片上传
• 更改引导样式简单
• 支持 Turbolinks
• 便于非开发者使用

示例

演示

Demo: Source

安装

添加 intro 到 Gemfile:

gem 'intro'

执行下面这行代码安装:

$ bundle install

生成迁移以及配置文件:

$ rails generate intro:install

然后执行迁移:

$ rails db:migrate

然后编译资源:

$ rails assets:precompile

使用

将资源文件添加至视图

添加 intro_tags 在共用的 layout 中, 在 body 标签关闭之前:

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

intro_tags 引入了 intro 相关资源文件和添加了一个记录 intro 配置的全局变量 _intro 。

Note: 如果你正在使用 Turbolinks, 为了更新 _intro 变量， intro_tags 须插入在 body 关闭之前。

后台添加引导

运行 Rails 应用并访问 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

更改它们以满足你的需要。

最后，在 config/initializers/intro.rb 中启用 custom_assets 设置。

# config/initializers/intro.rb

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

这将会在 intro_tags 中引用 intro/custom 资源。

配置 Intro

查看 config/initializers/intro.rb 获取详情的配置信息

致谢

• shepherd
• abraham

贡献

欢迎报告 Bug 或提交 Pull Request。

1. 分叉此仓库
2. 创建你的功能分支 (git checkout -b my-new-feature)
3. 提交你的改动 (git commit -am 'Add some feature')
4. 推送到当前分支 (git push origin my-new-feature)

如有必要，请为你的代码编写单元测试。

许可

根据 MIT 许可的条款，此仓库可作为开放源代码使用。