Merge pull request #391 from Peefy/doc-add-doc-gen-escape-html-flag

docs: add doc gen escape html flag docs

Author: Peefy

docs/tools/cli/kcl/docgen.md

@@ -78,6 +78,12 @@ Generate Markdown document for specific package to a `<target directory>`
 kcl doc generate --file-path <package path> --target <target directory>
 ```
 
+If you encounter output format issues such as HTML or Markdown, such as symbol display errors such as `|`, `\n`, etc., you can add the `--escape-html` flag.
+
+```shell
+kcl doc generate --escape-html
+```
+
 ## Appendix
 
 ### Concept of reST

i18n/zh-CN/docusaurus-plugin-content-docs/current/tools/cli/kcl/docgen.md

@@ -78,6 +78,12 @@ kcl doc generate --file-path <package path>
 kcl doc generate --file-path <package path> --target <target directory>
 ```
 
+如果您遇到了 HTML 或者 Markdown 等输出格式问题，比如 `|`, `\n` 等符号显示错误，您可以添加 `--escape-html` 标志
+
+```shell
+kcl doc generate --escape-html
+```
+
 ## 文档工具附录
 
 ### 常见的 reST 概念

i18n/zh-CN/docusaurus-plugin-content-docs/version-0.9/tools/cli/kcl/docgen.md

@@ -78,6 +78,12 @@ kcl doc generate --file-path <package path>
 kcl doc generate --file-path <package path> --target <target directory>
 ```
 
+如果您遇到了 HTML 或者 Markdown 等输出格式问题，比如 `|`, `\n` 等符号显示错误，您可以添加 `--escape-html` 标志
+
+```shell
+kcl doc generate --escape-html
+```
+
 ## 文档工具附录
 
 ### 常见的 reST 概念

i18n/zh-CN/docusaurus-plugin-content-docs/version-0.9/user_docs/support/faq-kcl.md

@@ -2642,4 +2642,4 @@ another_module = "0.1.1"
 import another_module
 ```
 
-`another-module = "0.1.1"` 和 `another_module = "0.1.1"` 是等价的, 如果同时在 `kcl.mod` 中使用这两种写法会得到一个错误。
+`another-module = "0.1.1"` 和 `another_module = "0.1.1"` 是等价的, 如果同时在 `kcl.mod` 中使用这两种写法会得到一个错误。

versioned_docs/version-0.9/tools/cli/kcl/docgen.md

@@ -78,6 +78,12 @@ Generate Markdown document for specific package to a `<target directory>`
 kcl doc generate --file-path <package path> --target <target directory>
 ```
 
+If you encounter output format issues such as HTML or Markdown, such as symbol display errors such as `|`, `\n`, etc., you can add the `--escape-html` flag.
+
+```shell
+kcl doc generate --escape-html
+```
+
 ## Appendix
 
 ### Concept of reST

versioned_docs/version-0.9/user_docs/getting-started/index.md

@@ -1,6 +1,6 @@
 # Getting Started
 
-Get started include a quick overview of the KCL programming language.
+Getting Started include a quick overview of the KCL programming language.
 
 import DocCardList from '@theme/DocCardList';