From c9964361b0fd41e3397822aa83bd9ae6da72063f Mon Sep 17 00:00:00 2001 From: oppofind <836575280@qq.com> Date: Wed, 16 Sep 2020 21:55:27 +0800 Subject: [PATCH] update readme --- README.md | 16 ++++++++-------- README_CN.md | 10 +++++----- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 786474e..da80250 100644 --- a/README.md +++ b/README.md @@ -166,21 +166,21 @@ So the project configuration can also refer to the introduction of smart-doc. #### Run plugin with maven command ``` // Generate html -mvn -Dfile.encoding = UTF-8 smart-doc: html +mvn -Dfile.encoding=UTF-8 smart-doc: html // Generate markdown -mvn -Dfile.encoding = UTF-8 smart-doc: markdown +mvn -Dfile.encoding=UTF-8 smart-doc: markdown // Generate adoc -mvn -Dfile.encoding = UTF-8 smart-doc: adoc +mvn -Dfile.encoding=UTF-8 smart-doc: adoc // 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 -mvn -Dfile.encoding = UTF-8 smart-doc:rpc-html +mvn -Dfile.encoding=UTF-8 smart-doc:rpc-html // Generate markdown -mvn -Dfile.encoding = UTF-8 smart-doc:rpc-markdown +mvn -Dfile.encoding=UTF-8 smart-doc:rpc-markdown // 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, non-English characters may be garbled, so you need to specify `-Dfile.encoding = UTF-8` during execution. diff --git a/README_CN.md b/README_CN.md index 93464a5..fb56871 100644 --- a/README_CN.md +++ b/README_CN.md @@ -180,15 +180,15 @@ mvn -Dfile.encoding=UTF-8 smart-doc:adoc //生成postman json数据 mvn -Dfile.encoding=UTF-8 smart-doc:postman // 生成 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 -mvn -Dfile.encoding = UTF-8 smart-doc:rpc-html +mvn -Dfile.encoding=UTF-8 smart-doc:rpc-html // Generate markdown -mvn -Dfile.encoding = UTF-8 smart-doc:rpc-markdown +mvn -Dfile.encoding=UTF-8 smart-doc:rpc-markdown // 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`。 #### Use Idea