wanjia950611
/
smart-doc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update README_CN.md

This commit is contained in:
oppofind 2020-12-13 01:18:27 +08:00
parent 46bd8514b6
commit 7835740726
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@ -5,9 +5,9 @@
- 更新内容： - 更新内容：
1. 优化了文档的显示，将query和path单独提出来做了展示 1. 优化了文档的显示，将query和path单独提出来做了展示
2. 优化openapi 3.0文档规范的支持，可集成swagger ui等ui使用。 2. 优化openapi 3.0文档规范的支持，可集成swagger ui等ui使用。
3. 使用postman collection 2.0的支持。 3. 优化postman collection 2.0的支持。
4. 添加分组支持group。 4. 添加分组支持group。
5. 修改mock的依稀bug和增强使用 5. 修改mock的一些bug和增强使用
6. 支出创建debug页面 6. 支出创建debug页面
#### 版本号：1.9.9.1 #### 版本号：1.9.9.1
- 更新日期: 2020-11-23 - 更新日期: 2020-11-23

4
README_CN.md
View File

@ -25,7 +25,7 @@ $\color{red}{你给我的star，胜过所有读过的诗—smart-doc}$
- 支持生成JSON返回值示例。 - 支持生成JSON返回值示例。
- 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。 - 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。
- 支持生成多种格式文档：Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。 - 支持生成多种格式文档：Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。
- 轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。 - 轻易实现在Spring Boot服务上在线查看静态HTML5 api文档，支持生成在线debug页面。
- 开放文档数据，可自由实现接入文档管理系统。 - 开放文档数据，可自由实现接入文档管理系统。
- 支持导出错误码和定义在代码中的各种字典码到接口文档。 - 支持导出错误码和定义在代码中的各种字典码到接口文档。
- 支持Maven、Gradle插件式轻松集成。 - 支持Maven、Gradle插件式轻松集成。
@ -94,7 +94,7 @@ smart-doc官方目前已经开发完成[Maven插件](https://gitee.com/smart-doc
"allInOne": true, //是否将文档合并到一个文件中，一般推荐为true "allInOne": true, //是否将文档合并到一个文件中，一般推荐为true
"outPath": "D://md2", //指定文档的输出路径 "outPath": "D://md2", //指定文档的输出路径
"coverOld": true, //是否覆盖旧的文件，主要用于mardown文件覆盖 "coverOld": true, //是否覆盖旧的文件，主要用于mardown文件覆盖
"createDebugPage": true,//@since 2.0.0 smart-doc支持创建可以测试的html页面 "createDebugPage": true,//@since 2.0.0 smart-doc支持创建可以测试的html页面，仅在AllInOne模式中起作用。
"packageFilters": "",//controller包过滤，多个包用英文逗号隔开 "packageFilters": "",//controller包过滤，多个包用英文逗号隔开
"md5EncryptedHtmlName": false,//只有每个controller生成一个html文件是才使用 "md5EncryptedHtmlName": false,//只有每个controller生成一个html文件是才使用
"style":"xt256", //基于highlight.js的代码高设置,可选值很多可查看码云wiki，喜欢配色统一简洁的同学可以不设置 "style":"xt256", //基于highlight.js的代码高设置,可选值很多可查看码云wiki，喜欢配色统一简洁的同学可以不设置