Skip to content

Commit

Permalink
docs: add doc gen escape html flag docs
Browse files Browse the repository at this point in the history
Signed-off-by: peefy <xpf6677@163.com>
  • Loading branch information
Peefy committed Jun 20, 2024
1 parent e9c48ce commit 37ccc35
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 2 deletions.
6 changes: 6 additions & 0 deletions docs/tools/cli/kcl/docgen.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 概念
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 概念
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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` 中使用这两种写法会得到一个错误。
6 changes: 6 additions & 0 deletions versioned_docs/version-0.9/tools/cli/kcl/docgen.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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';

Expand Down

0 comments on commit 37ccc35

Please sign in to comment.