Skip to content

Commit d486b82

Browse files
committed
docs: update readme
1 parent 0e651c9 commit d486b82

File tree

4 files changed

+18
-6
lines changed

4 files changed

+18
-6
lines changed

README-en.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Create React Doc provides the official default theme [crd-seed](https://github.c
4343
* Support dark mode.
4444
* The document supports embedded codepen, codesandbox.
4545
* GitHub linkage.
46+
* Support using tags to customize aggregate article content.
4647

4748
The projects built using this theme are:
4849

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,11 @@ abbrlink: s31w9gd1
4242

4343
create-react-doc 提供了官方默认主题 [crd-seed](https://github.com/MuYunyun/create-react-doc/tree/main/packages/crd-seed)。该主题支持以下特性:
4444

45-
* 适配移动、PC 多端展示
45+
* 适配移动、PC 端展示
4646
* 支持暗黑模式。
47-
* 文档支持内嵌 codepen、codesandbox。
48-
* GitHub 联动。
47+
* 支持文档内嵌展示 codepen、codesandbox 案例。
48+
* 支持与 GitHub 文档编辑能力联动。
49+
* 支持配置展示标签以自定义聚合文章内容。
4950

5051
[笔者博客](http://muyunyun.cn/blog) 就是使用默认主题搭建的。
5152

docs/Front-matter.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,16 @@ Front-matter 是文件最上方包裹在 `<!--` 与 `-->` 之间的区域,用
99
```md
1010
<!--
1111
abbrlink: 290a4219
12+
tags: ['customTag1', 'customTag2']
1213
-->
1314
```
1415

1516
以下是预先定义的参数,您可在模板中使用这些参数值并加以利用。
1617

17-
| 参数 | 描述 | 默认值 |
18-
| :------- | :-------------------------------------------------------------- | :----- |
19-
| abbrlink | 短链。用于指定页面路由展示为指定短链,使用短链有助于 SEO 搜索。 | |
18+
| 参数 | 描述 | 类型 |
19+
| :------- | :-------------------------------------------------------------- | :------- |
20+
| abbrlink | 短链。用于指定页面路由展示为指定短链,使用短链有助于 SEO 搜索。 | |
21+
| tags | 自定义标签 | string[] |
2022

2123
## 链接持久化
2224

docs/更新日志.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@ abbrlink: 179nqpxt
66

77
`create-react-doc` 严格遵循 [Semantic Versioning 2.0.0](http://semver.org/lang/zh-CN/) 语义化版本规范。
88

9+
### 1.9.0
10+
11+
`2022-04-01`
12+
13+
- **Feature**
14+
15+
- 🚀 支持配置展示标签页以自定义聚合文章内容。[issue](https://github.com/MuYunyun/create-react-doc/issues/264)
16+
917
### 1.8.2
1018

1119
`2022-02-02`

0 commit comments

Comments
 (0)