{"id":17599100,"url":"https://github.com/jinhucheung/intro","last_synced_at":"2025-07-27T05:33:06.992Z","repository":{"id":35056030,"uuid":"194819424","full_name":"jinhucheung/intro","owner":"jinhucheung","description":"Intro brings your rails application to new feature introduction and step-by-step users guide.","archived":true,"fork":false,"pushed_at":"2025-03-29T11:27:46.000Z","size":328,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-30T06:08:24.960Z","etag":null,"topics":["intro","rails","rails-engine","shepherd","tour","user-guide"],"latest_commit_sha":null,"homepage":"https://github.com/jinhucheung/intro","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jinhucheung.png","metadata":{"files":{"readme":"README-CN.md","changelog":null,"contributing":null,"funding":null,"license":"MIT-LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-02T08:15:47.000Z","updated_at":"2025-03-29T11:27:51.000Z","dependencies_parsed_at":"2024-10-22T19:12:13.909Z","dependency_job_id":null,"html_url":"https://github.com/jinhucheung/intro","commit_stats":{"total_commits":75,"total_committers":2,"mean_commits":37.5,"dds":"0.19999999999999996","last_synced_commit":"ba67d38222a7ae26e189ebd540e2e78b029dfaab"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/jinhucheung/intro","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jinhucheung%2Fintro","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jinhucheung%2Fintro/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jinhucheung%2Fintro/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jinhucheung%2Fintro/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jinhucheung","download_url":"https://codeload.github.com/jinhucheung/intro/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jinhucheung%2Fintro/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267306764,"owners_count":24067035,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-27T02:00:11.917Z","response_time":82,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["intro","rails","rails-engine","shepherd","tour","user-guide"],"created_at":"2024-10-22T10:09:13.006Z","updated_at":"2025-07-27T05:33:06.662Z","avatar_url":"https://github.com/jinhucheung.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Intro\n\n[![Gem Version](https://badge.fury.io/rb/intro.svg)](https://badge.fury.io/rb/intro)\n[![Build Status](https://travis-ci.org/jinhucheung/intro.svg?branch=master)](https://travis-ci.org/jinhucheung/intro)\n\nIntro 为 Rails 应用添加新功能介绍以及用户指引，她根据用户是否需要功能引导，动态注入了 [Shepherd.js](https://github.com/shipshapecode/shepherd) 脚本至应用中。Intro 包含以下功能：\n\n+ 可在后台中管理用户引导\n+ 引导内容支持多语言及图片上传\n+ 更改引导样式简单\n+ 支持 Turbolinks\n+ 便于非开发者使用\n\n## 示例\n\n![example](https://user-images.githubusercontent.com/19590194/64253419-dbe38d80-cf4f-11e9-9aab-b1e6058990ab.png)\n\n## 演示\n\n[Demo](https://intro-demo.herokuapp.com/): [Source](https://github.com/jinhucheung/intro-demo)\n\n## 安装\n\n添加 `intro` 到 Gemfile:\n\n```\ngem 'intro'\n```\n\n执行下面这行代码安装:\n\n```\n$ bundle install\n```\n\n生成迁移以及配置文件:\n\n```\n$ rails generate intro:install\n```\n\n然后执行迁移:\n\n```\n$ rails db:migrate\n```\n\n然后编译资源:\n\n```\n$ rails assets:precompile\n```\n\n## 使用\n\n### 将资源文件添加至视图\n\n添加 `intro_tags` 在共用的 layout 中, 在 body 标签关闭之前:\n\n```\n\u003c%= intro_tags %\u003e\n\u003c/body\u003e\n\u003c/html\u003e\n```\n\n`intro_tags` 引入了 intro 相关资源文件和添加了一个记录 intro 配置的全局变量 `_intro` 。\n\n**Note**: 如果你正在使用 Turbolinks, 为了更新 `_intro` 变量， `intro_tags` 须插入在 body 关闭之前。\n\n### 后台添加引导\n\n运行 Rails 应用并访问 `http://localhost:3000/intro/admin`。在 `config/initializers/intro.rb` 文件中，你可以获取到默认的帐号以登录后台。\n\n然后添加引导并填入相关内容，最后你需要发布它。\n\n### 更改引导样式\n\n如果默认样式不能满足你，你可以执行下面代码生成样式文件:\n\n```\n$ rails generate intro:assets\n```\n\n你将会得到下面的文件:\n\n```\napp/javascript/stylesheets/intro/_variables.scss\napp/javascript/stylesheets/intro/custom.scss\napp/javascript/packs/intro/custom.js\n```\n\n更改它们以满足你的需要。\n\n最后，在 `config/initializers/intro.rb` 中启用 `custom_assets` 设置。\n\n```\n# config/initializers/intro.rb\n\n# override intro tour styles\nself.custom_assets = true # or 'intro/custom'\n```\n\n这将会在 `intro_tags` 中引用 `intro/custom` 资源。\n\n### 配置 Intro\n\n查看 `config/initializers/intro.rb` 获取详情的配置信息\n\n## 致谢\n\n+ [shepherd](https://github.com/shipshapecode/shepherd)\n+ [abraham](https://github.com/actmd/abraham)\n\n## 贡献\n\n欢迎报告 Bug 或提交 Pull Request。\n\n1. 分叉此仓库\n2. 创建你的功能分支 (git checkout -b my-new-feature)\n3. 提交你的改动 (git commit -am 'Add some feature')\n4. 推送到当前分支 (git push origin my-new-feature)\n\n如有必要，请为你的代码编写单元测试。\n\n## 许可\n\n根据 [MIT](MIT-LICENSE) 许可的条款，此仓库可作为开放源代码使用。","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjinhucheung%2Fintro","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjinhucheung%2Fintro","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjinhucheung%2Fintro/lists"}