From 37ccc35b9bc3bc4e3492f418ba060faddfc4045c Mon Sep 17 00:00:00 2001
From: peefy <xpf6677@163.com>
Date: Thu, 20 Jun 2024 18:20:40 +0800
Subject: [PATCH] docs: add doc gen escape html flag docs

Signed-off-by: peefy <xpf6677@163.com>
---
 docs/tools/cli/kcl/docgen.md                                | 6 ++++++
 .../current/tools/cli/kcl/docgen.md                         | 6 ++++++
 .../version-0.9/tools/cli/kcl/docgen.md                     | 6 ++++++
 .../version-0.9/user_docs/support/faq-kcl.md                | 2 +-
 versioned_docs/version-0.9/tools/cli/kcl/docgen.md          | 6 ++++++
 .../version-0.9/user_docs/getting-started/index.md          | 2 +-
 6 files changed, 26 insertions(+), 2 deletions(-)

diff --git a/docs/tools/cli/kcl/docgen.md b/docs/tools/cli/kcl/docgen.md
index 356d0269..63465336 100644
--- a/docs/tools/cli/kcl/docgen.md
+++ b/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
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/tools/cli/kcl/docgen.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/tools/cli/kcl/docgen.md
index ad61b282..d2ba6531 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/tools/cli/kcl/docgen.md
+++ b/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 概念
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.9/tools/cli/kcl/docgen.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.9/tools/cli/kcl/docgen.md
index ad61b282..d2ba6531 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.9/tools/cli/kcl/docgen.md
+++ b/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 概念
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.9/user_docs/support/faq-kcl.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.9/user_docs/support/faq-kcl.md
index d7499340..ca546129 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.9/user_docs/support/faq-kcl.md
+++ b/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` 中使用这两种写法会得到一个错误。
\ No newline at end of file
+`another-module = "0.1.1"` 和 `another_module = "0.1.1"` 是等价的, 如果同时在 `kcl.mod` 中使用这两种写法会得到一个错误。
diff --git a/versioned_docs/version-0.9/tools/cli/kcl/docgen.md b/versioned_docs/version-0.9/tools/cli/kcl/docgen.md
index 356d0269..63465336 100644
--- a/versioned_docs/version-0.9/tools/cli/kcl/docgen.md
+++ b/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
diff --git a/versioned_docs/version-0.9/user_docs/getting-started/index.md b/versioned_docs/version-0.9/user_docs/getting-started/index.md
index bf978d97..f1d7bfee 100644
--- a/versioned_docs/version-0.9/user_docs/getting-started/index.md
+++ b/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';