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

update readme

This commit is contained in:
oppofind 2020-09-16 21:55:27 +08:00
parent 1040daeb2f
commit c9964361b0
2 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -166,21 +166,21 @@ So the project configuration can also refer to the introduction of smart-doc.
#### Run plugin with maven command #### Run plugin with maven command
``` ```
// Generate html // Generate html
mvn -Dfile.encoding = UTF-8 smart-doc: html mvn -Dfile.encoding=UTF-8 smart-doc: html
// Generate markdown // Generate markdown
mvn -Dfile.encoding = UTF-8 smart-doc: markdown mvn -Dfile.encoding=UTF-8 smart-doc: markdown
// Generate adoc // Generate adoc
mvn -Dfile.encoding = UTF-8 smart-doc: adoc mvn -Dfile.encoding=UTF-8 smart-doc: adoc
// Generate postman collection // Generate postman collection
mvn -Dfile.encoding = UTF-8 smart-doc: postman mvn -Dfile.encoding=UTF-8 smart-doc: postman
// Apache Dubbo Rpc // Apache Dubbo RPC
// Generate html // Generate html
mvn -Dfile.encoding = UTF-8 smart-doc:rpc-html mvn -Dfile.encoding=UTF-8 smart-doc:rpc-html
// Generate markdown // Generate markdown
mvn -Dfile.encoding = UTF-8 smart-doc:rpc-markdown mvn -Dfile.encoding=UTF-8 smart-doc:rpc-markdown
// Generate adoc // Generate adoc
mvn -Dfile.encoding = UTF-8 smart-doc:rpc-adoc mvn -Dfile.encoding=UTF-8 smart-doc:rpc-adoc
``` ```
**Note:** Under the window system, if you use the maven command line to perform document generation, **Note:** Under the window system, if you use the maven command line to perform document generation,
non-English characters may be garbled, so you need to specify `-Dfile.encoding = UTF-8` during execution. non-English characters may be garbled, so you need to specify `-Dfile.encoding = UTF-8` during execution.

10
README_CN.md
View File

@ -180,15 +180,15 @@ mvn -Dfile.encoding=UTF-8 smart-doc:adoc
//生成postman json数据 //生成postman json数据
mvn -Dfile.encoding=UTF-8 smart-doc:postman mvn -Dfile.encoding=UTF-8 smart-doc:postman
// 生成 Open Api 3.0+,Since smart-doc-maven-plugin 1.1.5 // 生成 Open Api 3.0+,Since smart-doc-maven-plugin 1.1.5
mvn -Dfile.encoding = UTF-8 smart-doc:openapi mvn -Dfile.encoding=UTF-8 smart-doc:openapi
// Apache Dubbo Rpc文档 // Apache Dubbo RPC文档
// Generate html // Generate html
mvn -Dfile.encoding = UTF-8 smart-doc:rpc-html mvn -Dfile.encoding=UTF-8 smart-doc:rpc-html
// Generate markdown // Generate markdown
mvn -Dfile.encoding = UTF-8 smart-doc:rpc-markdown mvn -Dfile.encoding=UTF-8 smart-doc:rpc-markdown
// Generate adoc // Generate adoc
mvn -Dfile.encoding = UTF-8 smart-doc:rpc-adoc mvn -Dfile.encoding=UTF-8 smart-doc:rpc-adoc
``` ```
**注意：** 尤其在window系统下，如果实际使用maven命令行执行文档生成，可能会出现乱码，因此需要在执行时指定`-Dfile.encoding=UTF-8`。 **注意：** 尤其在window系统下，如果实际使用maven命令行执行文档生成，可能会出现乱码，因此需要在执行时指定`-Dfile.encoding=UTF-8`。
#### Use Idea #### Use Idea