Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 22 days ago
JSON representation

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

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 %>