Skip to content

Commit

Permalink
doc: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jaywcjlove committed May 7, 2022
1 parent 3a63868 commit 4082343
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion core/README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ export type CodeBlockData = {

## 配置 meta 标识

注意:需要在代码块示例中添加特殊的 `meta` 标识,`loader` 才会去索引对于的 `react` 示例,进行代码转换。
注意 ⚠️:需要在代码块示例中添加特殊的 `meta` 标识,`loader` 才会去索引对于的 `react` 示例,进行代码转换。

1. `mdx:` 特殊标识前缀
2. `mdx:preview` 控制是否进行进行示例索引,通过对应所在行号,获取需要的示例对象。
Expand Down
2 changes: 1 addition & 1 deletion core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Pass the `markdown` file content string, and return the converted code block par

## Configure meta ID

Note: You need to add a special `meta` identifier to the code block example, and `loader` will index the `react` example for code conversion.
Note ⚠️: You need to add a special `meta` identifier to the code block example, and `loader` will index the `react` example for code conversion.

1. `mdx:` special identifier prefix
2. `mdx:preview` Controls whether to perform example indexing, and obtain the required example object through the corresponding line number.
Expand Down

0 comments on commit 4082343

Please sign in to comment.