Skip to content

Commit 1cc6c19

Browse files
committed
docs: some enhancements
1 parent d987ea5 commit 1cc6c19

File tree

6 files changed

+244
-89
lines changed

6 files changed

+244
-89
lines changed

packages/docs/docs/config/README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -130,8 +130,7 @@ Create a `.vuepress/style/index.styl` file and it will be applied as global styl
130130

131131
**Also see:**
132132

133-
- [Why can't `palette.styl` and `index.styl` merge into one API?](faq/#why-can-t-palette-styl-and-index-styl-merge-into-one-api)
134-
- [Why can't `palette.styl` and `index.styl` merge into one API?](faq/#why-can-t-palette-styl-and-index-styl-merge-into-one-api)
133+
- [Why can't `palette.styl` and `index.styl` merge into one API?](../faq/README.md#why-can-t-palette-styl-and-index-styl-merge-into-one-api)
135134

136135
## Theming
137136

@@ -160,11 +159,7 @@ Provide config options to the used theme. The options will vary depending on the
160159
- Type: `Object|Array`
161160
- Default: `undefined`
162161

163-
For default usage, please refer to [plugin API](../plugin/README.md).
164-
165-
::: tip
166-
There is a hidden feature. `.vuepress/config.js` also supports all [options](../plugin/README.md#options) of Plugin API.
167-
:::
162+
Please refer to [plugin API > Using a plugin](../plugin/README.md#using-a-plugin) to leran how to use a plugin.
168163

169164
## Markdown
170165

packages/docs/docs/plugin/official.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,41 @@
22
sidebar: auto
33
---
44

5-
- TODO
6-
75
# Official Plugins
86

97
## @vuepress/search
108

11-
### Options
9+
- TODO
1210

1311
## @vuepress/pwa
1412

15-
### Options
13+
- TODO
1614

1715
## @vuepress/blog
1816

19-
### Options
17+
- TODO
2018

2119
## @vuepress/pagination
2220

23-
### Options
21+
- TODO
2422

2523
## @vuepress/google-analytics
2624

27-
### Options
25+
- TODO
2826

2927
## @vuepress/i18n-ui
3028

31-
### Options
29+
- TODO
3230

3331
## @vuepress/last-updated
3432

35-
### Options
33+
- TODO
3634

3735
## @vuepress/medium-zoom
3836

39-
### Options
37+
- TODO
4038

4139
## @vuepress/back-to-top
4240

43-
### Options
41+
- TODO
4442

packages/docs/docs/theme/README.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -240,10 +240,3 @@ The plugin whose name starts with `@vuepress/theme-` is an officially maintained
240240
- Default: undefined
241241

242242
See: [Config > plugins](../config/README.md#plugins).
243-
244-
### palette
245-
246-
- Type: `String|Object`
247-
- Default: undefined
248-
249-
See: [Config > palette](../config/README.md#palette).

packages/docs/docs/zh/config/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,20 @@ module.exports = {
115115

116116
一个函数,用来控制对于哪些文件,是需要生成 `<link rel="prefetch">` 资源提示的。请参考 [shouldPrefetch](https://ssr.vuejs.org/zh/api/#shouldpreload)
117117

118+
## 样式
119+
120+
### palette.styl
121+
122+
创建一个 `.vuepress/style/palette.styl` 文件,其会被自动注册为全局调色板。
123+
124+
### index.styl
125+
126+
创建一个 `.vuepress/style/index.styl` 文件, 其会被自动应用为全局样式
127+
128+
**Also see:**
129+
130+
- [Why can't `palette.styl` and `index.styl` merge into one API?](../faq/README.md#why-can-t-palette-styl-and-index-styl-merge-into-one-api)
131+
118132
## 主题
119133

120134
### theme
@@ -135,6 +149,15 @@ module.exports = {
135149

136150
- [默认主题](../theme/default-theme-config.md)
137151

152+
## Pluggable
153+
154+
### plugins
155+
156+
- Type: `Object|Array`
157+
- Default: `undefined`
158+
159+
请参考 [plugin API > Using a plugin](../plugin/README.md#using-a-plugin) 来使用一个插件。
160+
138161
## Markdown
139162

140163
### markdown.lineNumbers

packages/docs/docs/zh/plugin/official.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,37 +6,37 @@ sidebar: auto
66

77
## @vuepress/search
88

9-
### Options
9+
- TODO
1010

1111
## @vuepress/pwa
1212

13-
### Options
13+
- TODO
1414

1515
## @vuepress/blog
1616

17-
### Options
17+
- TODO
1818

1919
## @vuepress/pagination
2020

21-
### Options
21+
- TODO
2222

2323
## @vuepress/google-analytics
2424

25-
### Options
25+
- TODO
2626

2727
## @vuepress/i18n-ui
2828

29-
### Options
29+
- TODO
3030

3131
## @vuepress/last-updated
3232

33-
### Options
33+
- TODO
3434

3535
## @vuepress/medium-zoom
3636

37-
### Options
37+
- TODO
3838

3939
## @vuepress/back-to-top
4040

41-
### Options
41+
- TODO
4242

0 commit comments

Comments
 (0)