Kity Demo 编写规范 ===== 本目录存放 Kity 的 Demo,需要贡献 Demo 的,请遵守本规范。 ## Demo 类型 Demo 允许以单个 HTML 页面存在,也可以以目录的形式存在。 如果 Demo 以目录的形式存在,Demo 的入口*必须是 index.html* 。可以在 Demo 目录中存放该 Demo 所需要的资源。但是如果资源可能能被其他 Demo 复用,那么应该把资源存放在 `public` 目录下。 ## 页面结构 单页面的 Demo,或者目录形式的 Demo 的 index.html,应该遵循以下页面结构。 ```html Demo 标题 ``` ## 其他说明 1. 如果 Demo 在开发中,那么应该给 Demo 文件名或目录名前面加一个下划线,表示 Demo 不会被扫描发布。 2. `_sample.html` 是上述页面结构的源文件,开始一个新 Demo 可以从拷贝修改该文件开始。 3. 贡献了 Demo,请给我们提 pull request。欢迎一起丰富 kity 的 Demo 库!