KISSY@5.0 文档系统

1. 为什么要做新的文档系统

2. 文档系统的实现方案

KISSY@5.0 文档系统

1. 为什么要做新的文档系统

• 结构紊乱，重点不突出
• API文档构建工具语法不简洁，不支持继承
• Demos示例调试麻烦

KISSY@5.0 文档系统

1. 文档系统实现方案

• 主要内容
• 新功能
• 工具化

KISSY@5.0 文档系统

• 主要内容：

  • 清晰明了的结构
  • 完成大部分模块的文档编写（API、教程、Demo）
  • 设计界面，完成改造

KISSY@5.0 文档系统

• 新功能

  • 在线编辑
  • 二维码，方便移动端调试
  • 提取Markdown二级标题作为页面大纲
  • API文档局部刷新，支持浏览器前进后退

KISSY@5.0 文档系统

• 工具化

  • YUIDOC文档生成工具
  • Gulp构建，工程化，贡献代码变得更加简单快捷
  • bower依赖，聚合各库API源码，生成API文档
  • 编写自动部署脚本，github上添加webhook，服务器自动部署

KISSY@5.0文档地址

工具

1. gulp-joycss 合并小图标
2. aggregare-bower  聚合KISSY各模块库构建KISSY
3. gh-changelog  提取github仓库changelog
4. 文档系统webhook  自动部署文档

工具

1. gulp-joycss

• 独立editor-plugins
• 多图标
• js源码commonjs规范

工具

2. aggregate-bower

• KISSY 所有模块独立成库，bower包
• 聚合所有模块包构建KISSY框架
• 提取必要的模块别名信息等

工具

3. gh-changelog

• ​​kissyteam 仓库较多，版本较多
• 缺少版本升级信息

工具

4. webhook

• 文档系统仓库在github上，小修改反复pull麻烦
• 自动部署脚本