Intro 为 Rails 应用添加新功能介绍以及用户指引,她根据用户是否需要功能引导,动态注入了 Shepherd.js 脚本至应用中。Intro 包含以下功能:
添加 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
资源。
查看 config/initializers/intro.rb
获取详情的配置信息
欢迎报告 Bug 或提交 Pull Request。
如有必要,请为你的代码编写单元测试。
根据 MIT 许可的条款,此仓库可作为开放源代码使用。
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。
1. 开源生态
2. 协作、人、软件
3. 评估模型