https://github.com/jinhucheung/intro

Intro brings your rails application to new feature introduction and step-by-step users guide.
https://github.com/jinhucheung/intro

intro rails rails-engine shepherd tour user-guide

Last synced: 11 months ago
JSON representation

Intro brings your rails application to new feature introduction and step-by-step users guide.

• Host: GitHub
• URL: https://github.com/jinhucheung/intro
• Owner: jinhucheung
• License: mit
• Archived: true
• Created: 2019-07-02T08:15:47.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2025-03-29T11:27:46.000Z (about 1 year ago)
• Last Synced: 2025-04-30T06:08:24.960Z (about 1 year ago)
• Topics: intro, rails, rails-engine, shepherd, tour, user-guide
• Language: Ruby
• Homepage: https://github.com/jinhucheung/intro
• Size: 320 KB
• Stars: 5
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README-CN.md
  • License: MIT-LICENSE

Awesome Lists containing this project

README

          
# Intro

[![Gem Version](https://badge.fury.io/rb/intro.svg)](https://badge.fury.io/rb/intro)

[![Build Status](https://travis-ci.org/jinhucheung/intro.svg?branch=master)](https://travis-ci.org/jinhucheung/intro)

Intro 为 Rails 应用添加新功能介绍以及用户指引，她根据用户是否需要功能引导，动态注入了 [Shepherd.js](https://github.com/shipshapecode/shepherd) 脚本至应用中。Intro 包含以下功能：

+ 可在后台中管理用户引导

+ 引导内容支持多语言及图片上传

+ 更改引导样式简单

+ 支持 Turbolinks

+ 便于非开发者使用

## 示例

![example](https://user-images.githubusercontent.com/19590194/64253419-dbe38d80-cf4f-11e9-9aab-b1e6058990ab.png)

## 演示

[Demo](https://intro-demo.herokuapp.com/): [Source](https://github.com/jinhucheung/intro-demo)

## 安装

添加 `intro` 到 Gemfile:

```

gem 'intro'

```

执行下面这行代码安装:

```

$ bundle install

```

生成迁移以及配置文件:

```

$ rails generate intro:install

```

然后执行迁移:

```

$ rails db:migrate

```

然后编译资源:

```

$ rails assets:precompile

```

## 使用

### 将资源文件添加至视图

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

```

<%= intro_tags %>