API文档通过Markdown可视化交互与数据开发
文档支持多种Markdown编辑方式,最终的文档目标在于与后端协作,确保清晰准确地输出接口文档。通常,接口文档会存在内容模糊或遗漏,因此建议通过表单规范来确保完整性。尽管当前工作主要基于Vue开发,本次使用React+TypeScript,学习与实践。
先决条件:
- 安装/更新 Node.js 至 >=12.* 版本
- 安装 Yarn:若未安装 Yarn,则执行 npm i -g yarn
开发命令:
- 启动:yarn start 或 npm run start(若无Yarn)
- 构建:yarn build 或 npm run build(若无Yarn)
帮助支持:如需帮助,请访问 Issue 跟踪器、聊天室或邮箱。
开发路线图:
1. 利用基础库开发并完善简易文档功能
2. 目标:为后续开发提供一个可复用且高效的文档编辑模板,简化接口文档协作流程。
503.6KB
文件大小:
评论区