介绍

---

sa-doc是什么？

一个基于markdown的接口文档编写工具

• 基础框架基于：docsify
• 书写格式参考：apidoc
• 根据markdown格式编写api接口文档，写时方便
• 自动将markdown格式转换为表格形式，看时方便

获取最新代码

• 你可以从gitee，或者github上获取最新代码
• gitee地址：https://gitee.com/click33/sa-doc
• github地址：https://github.com/click33/sa-doc

需求提交

• 我们深知一个优秀的项目需要海纳百川，点我在线提交需求

贡献代码

1. 在github上fork一份到自己的仓库
2. clone自己的仓库到本地电脑
3. 在本地电脑修改、commit、push
4. 提交pr（点击：New Pull Request）
5. 等待合并

建议贡献的地方

• 修复源码现有bug，或增加新的实用功能
• 完善在线文档，或者修复现有错误之处
• 如果更新实用功能，可在文档友情链接处留下自己的推广链接

sa系列其他工具

• sa-token：一个的JavaWeb权限认证框架，强大、简单、好用
• sa-admin：一个多窗口后台模板，流畅、易上手、提高生产力
• sa-fast：一个基于springboot架构的快速开发平台，内置代码生成器
• sa-vue-admin：对sa-admin的vue单页版实现, 基于vue-cli、element-ui的单页后台模板
• SqlFly：一个好用的ORM框架

交流群

QQ交流群：782974737 点击加入