README

Hopscotch

Hopscotch是一个框架，使开发者能够轻松地向其页面添加产品导览。Hopscotch接受一个导览JSON对象作为输入，并为开发者提供API来控制渲染导览显示和管理导览进度。

要了解有关Hopscotch和API的更多信息，请访问linkedin.github.io/hopscotch。

这里有什么？

• /archives包含Hopscotch先前和当前分发的.zip和.tar.gz文件。
• /demo有一个简单的带有Hopscotch导览的演示页面。大部分内容与github.io页面上的内容重复。
• /dist包括Hopscotch当前版本的编译文件。当发布新版本时，此文件夹会被压缩成存档。
• /src包含Hopscotch的源文件，包括JavaScript和Less。如果您要更改以贡献到核心存储库，这将是在这里进行更改的地方。
• /test是我们使用Jasmine编写的核心框架的测试套件。

如何开始使用Hopscotch？

包含在/dist中的Hopscotch文件是使用Hopscotch的好起点。开箱即用，Hopscotch包括运行和交互导览的核心JavaScript、用于渲染气泡的默认模板以及提供基本外观和感觉的默认CSS文件。要开始使用，只需在您的页面上包含这些文件，然后使用Hopscotch API开始导览。虽然Hopscotch会在存在时使用YUI或jQuery，但它们不是必需的。

请访问linkedin.github.io/hopscotch以获取用法示例和实时导览示例。如果您想调整Hopscotch中包含的一些默认资源以满足项目的需求，请继续阅读有关如何修改和重新构建自定义版本的Hopscotch的详细信息。

如何构建Hopscotch？

Hopscotch使用Grunt.js构建。了解如何开始使用Grunt。运行grunt将构建Hopscotch（将工件发布到/tmp）并针对新构建的工件运行测试套件。

如何测试Hopscotch？

测试作为构建过程的一部分使用Jasmine测试框架进行。您可以通过运行grunt test来验证更改。

使用Travis CI针对每个pull request运行持续集成。请在提交pull request之前对测试套件进行更改验证！我们还建议在可能的情况下为任何新功能或错误修复添加新的测试。

如何调整Hopscotch以满足项目的需求？

根据您的用例，您可能需要修改和/或重建Hopscotch中包含的一些基本组件。一些可修改的选项包括...

• CSS调整：Hopscotch样式表是用LESS编写的。如果您更改了这些样式表的本地副本，它们将在构建Hopscotch时重新编译。
• 泡沫标记：Hopscotch 泡泡的内部标记使用模板进行渲染。有关详细信息，请参阅 /src/tl 下的 README.md 文件。在构建 Hopscotch 时，/src/tl 下的任何模板都将使用 JST 编译成 JavaScript，并包含在 Hopscotch.js 的底部。
• 回调与页面交互：有关 Hopscotch API 的详细信息以及您可以注册事件的旅游/呼出事件，请参阅 linkedin.github.io/hopscotch。使用回调将 Hopscotch 与您页面上可能有的其他库和/或展示元素集成。

我想贡献力量！我能如何帮助？

注意：我们目前正在将 Hopscotch 重构为一个新的基于模块的格式，这将有助于使可读性和维护性变得更加容易。在此工作正在进行时，我们将停止对 Hopscotch 主分支的更改，除了主要维护修复之外。请随时提交错误报告，但请注意，它们可能不会在当前库的迭代中得到解决。谢谢！

有关如何向 GitHub 上的公共 Hopscotch 仓库贡献的详细信息，请参阅 CONTRIBUTING.md。