Skip to content

Commit 6290469

Browse files
committed
chore: normalize custom containers
1 parent 4182af6 commit 6290469

File tree

22 files changed

+67
-67
lines changed

22 files changed

+67
-67
lines changed

docs/.vuepress/config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ const config: UserConfig<DefaultThemeOptions> = {
6767
lastUpdatedText: '上次更新',
6868
contributorsText: '贡献者',
6969

70-
// custom blocks
70+
// custom containers
7171
tip: '提示',
7272
warning: '注意',
7373
danger: '警告',

docs/guide/assets.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ We can reference our logo in current page like this:
4545

4646
![VuePress Logo](/hero.png)
4747

48-
:::tip
48+
::: tip
4949
Config reference: [public](../reference/config.md#public)
5050
:::
5151

@@ -69,7 +69,7 @@ To help with that, VuePress provides a built-in helper `$withBase` that generate
6969

7070
The helper is verbose in Markdown. So it might be more helpful for theme and plugin authors.
7171

72-
:::tip
72+
::: tip
7373
Config reference: [base](../reference/config.md#base)
7474
:::
7575

@@ -99,6 +99,6 @@ module.exports = {
9999
![Image from path alias](@alias/image.png)
100100
```
101101

102-
:::tip
102+
::: tip
103103
Config reference: [alias](../reference/config.md#alias)
104104
:::

docs/guide/configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ export = config
5353
</CodeGroupItem>
5454
</CodeGroup>
5555

56-
:::tip
56+
::: tip
5757
We will refer the config object as **VuePress Config**.
5858
:::
5959

@@ -69,7 +69,7 @@ Site config means that, no matter what theme you are using, these configurations
6969

7070
As we know, every site should have its own `lang`, `title`, `description`, etc. Thus, VuePress has built-in support for those options.
7171

72-
:::tip
72+
::: tip
7373
Check out the [Config Reference](../reference/config.md) for a full list of site config.
7474
:::
7575

@@ -79,6 +79,6 @@ Theme config will be processed by VuePress theme, so it depends on the theme you
7979

8080
If you don't specify the `theme` option of VuePress Config, the default theme will be used.
8181

82-
:::tip
82+
::: tip
8383
Check out the [Default Theme > Config Reference](../reference/default-theme/config.md) for theme config of default theme.
8484
:::

docs/guide/deployment.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The following guides are based on some shared assumptions:
2727

2828
Create `.github/workflows/docs.yml` to set up the workflow.
2929

30-
:::details Click to expand sample config
30+
::: details Click to expand sample config
3131
```yaml
3232
name: docs
3333

@@ -86,7 +86,7 @@ jobs:
8686
```
8787
:::
8888
89-
:::tip
89+
::: tip
9090
Please refer to [GitHub Pages official guide](https://pages.github.com/) for more details.
9191
:::
9292
@@ -100,7 +100,7 @@ Please refer to [GitHub Pages official guide](https://pages.github.com/) for mor
100100

101101
2. Create `.gitlab-ci.yml` to set up [GitLab CI](https://about.gitlab.com/stages-devops-lifecycle/continuous-integration/) workflow.
102102

103-
:::details Click to expand sample config
103+
::: details Click to expand sample config
104104
```yaml
105105
# choose a docker image to use
106106
image: node:14-buster
@@ -126,7 +126,7 @@ pages:
126126
```
127127
:::
128128

129-
:::tip
129+
::: tip
130130
Please refer to [GitLab Pages official guide](https://docs.gitlab.com/ce/user/project/pages/#getting-started) for more details.
131131
:::
132132

@@ -159,7 +159,7 @@ Please refer to [GitLab Pages official guide](https://docs.gitlab.com/ce/user/pr
159159

160160
3. After running `yarn docs:build`, deploy using the command `firebase deploy`.
161161

162-
:::tip
162+
::: tip
163163
Please refer to [Firebase CLI official guide](https://firebase.google.com/docs/cli) for more details.
164164
:::
165165

docs/guide/i18n.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ module.exports = {
4040

4141
If a locale does not have a `lang`, `title`, `description` or `head`, VuePress will fallback to the root-level values. You can omit the root level config as long as they are provided in each locale.
4242

43-
:::tip
43+
::: tip
4444
Config reference: [locales](../reference/config.md#locales)
4545
:::
4646

@@ -65,6 +65,6 @@ module.exports = {
6565
}
6666
```
6767

68-
:::tip
68+
::: tip
6969
Config reference: [Default Theme > locales](../reference/default-theme/config.md#locales)
7070
:::

docs/guide/markdown.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Embedded by markdown-it:
2121

2222
You might have noticed that, a `#` anchor is displayed when you hover the mouse on the headers of each section. By clicking the `#` anchor, you can jump to the section directly.
2323

24-
:::tip
24+
::: tip
2525
This header anchors extension is supported by [markdown-it-anchor](https://github.com/valeriangalliat/markdown-it-anchor).
2626

2727
Config reference: [markdown.anchor](../reference/config.md#markdown-anchor)
@@ -78,7 +78,7 @@ Take our documentation source files as an example:
7878
- Internal links to `.md` files will be converted to the [page route path](./page.md#routing), and both absolute path and relative path are supported.
7979
- External links will get `target="_blank" rel="noopener noreferrer"` attrs and a <OutboundLink /> indicator.
8080

81-
:::tip
81+
::: tip
8282
This links extension is supported by our built-in plugin.
8383

8484
Config reference: [markdown.links](../reference/config.md#markdown-links)
@@ -102,7 +102,7 @@ VuePress 2 is out :tada: !
102102

103103
VuePress 2 is out :tada: !
104104

105-
:::tip
105+
::: tip
106106
This emoji extension is supported by [markdown-it-emoji](https://github.com/markdown-it/markdown-it-emoji).
107107

108108
Config reference: [markdown.emoji](../reference/config.md#markdown-emoji)
@@ -124,7 +124,7 @@ If you want to put the table of contents (TOC) of your current page inside your
124124

125125
The headers in TOC will link to the corresponding [header anchors](#header-anchors), so TOC won't work well if you disable header anchors.
126126

127-
:::tip
127+
::: tip
128128
This toc extension is supported by our built-in plugin, which is forked and modified from [markdown-it-toc-done-right](https://github.com/nagaozen/markdown-it-toc-done-right).
129129

130130
Config reference: [markdown.toc](../reference/config.md#markdown-toc)
@@ -166,7 +166,7 @@ export const config: UserConfig = {
166166
}
167167
```
168168

169-
:::tip
169+
::: tip
170170
This syntax highlighting extension is supported by our built-in plugin.
171171

172172
Config reference: [markdown.code.highlight](../reference/config.md#markdown-code-highlight)
@@ -212,7 +212,7 @@ Examples for line ranges mark:
212212
- Multiple single lines: `{4,7,9}`
213213
- Combined: `{4,7-13,16,23-27,40}`
214214

215-
:::tip
215+
::: tip
216216
This line highlighting extension is supported by our built-in plugin, which is forked and modified from [markdown-it-highlight-lines](https://github.com/egoist/markdown-it-highlight-lines).
217217

218218
Config reference: [markdown.code.highlightLines](../reference/config.md#markdown-code-highlightlines)
@@ -254,7 +254,7 @@ const line2 = 'This is line 2'
254254
const line3 = 'This is line 3'
255255
```
256256

257-
:::tip
257+
::: tip
258258
This line numbers extension is supported by our built-in plugin.
259259

260260
Config reference: [markdown.code.lineNumbers](../reference/config.md#markdown-code-linenumbers)
@@ -268,7 +268,7 @@ To avoid your code blocks being compiled by Vue, VuePress will add [v-pre](https
268268

269269
You can add `:v-pre` / `:no-v-pre` mark in your fenced code blocks to override the value set in config.
270270

271-
:::warning
271+
::: warning
272272
The template syntax characters, for example, the "Mustache" syntax (double curly braces) might be parsed by the syntax highlighter. Thus, as the following example, `:no-v-pre` might not work well in some languages.
273273

274274
If you want to make Vue syntax work in those languages anyway, try to disable the default syntax highlighting and implement your own syntax highlighting in client side.
@@ -310,7 +310,7 @@ const onePlusTwoPlusThree = {{ 1 + 2 + 3 }}
310310
const onePlusTwoPlusThree = {{ 1 + 2 + 3 }}
311311
```
312312

313-
:::tip
313+
::: tip
314314
This v-pre extension is supported by our built-in plugin.
315315

316316
Config reference: [markdown.code.vPre](../reference/config.md#markdown-vpre)
@@ -359,7 +359,7 @@ This is default theme built-in `<Badge />` component <Badge text="demo" />
359359

360360
This is default theme built-in `<Badge />` component <Badge text="demo" />
361361

362-
:::tip
362+
::: tip
363363
Check out the [Built-in Components](../reference/components.md) for a full list of built-in components.
364364

365365
Check out the [Default Theme > Built-in Components](../reference/default-theme/components.md) for a full list of default theme built-in components.

docs/guide/page.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ You must have noticed that those fields are similar with the [Site Config](./con
4242

4343
Also, VuePress has built-in support for some frontmatter fields, and your theme may have its own special frontmatter, too.
4444

45-
:::tip
45+
::: tip
4646
Check out the [Frontmatter Reference](../reference/frontmatter.md) for a full list of VuePress built-in frontmatter.
4747

4848
Check out the [Default Theme > Frontmatter Reference](../reference/default-theme/frontmatter.md) for the frontmatter of default theme.

docs/reference/cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Options:
4646
-h, --help Display this message
4747
```
4848

49-
:::tip
49+
::: tip
5050
Options set by CLI will override those options with the same name in your config file.
5151
:::
5252

@@ -70,7 +70,7 @@ Options:
7070
-h, --help Display this message
7171
```
7272

73-
:::tip
73+
::: tip
7474
Options set by CLI will override those options with the same name in your config file.
7575
:::
7676

docs/reference/config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@ module.exports = {
292292

293293
Set to `false` to disable this plugin.
294294

295-
:::danger
295+
::: danger
296296
You should not configure it unless you understand what it is for.
297297
:::
298298

@@ -387,7 +387,7 @@ You should not configure it unless you understand what it is for.
387387

388388
Set to `false` to disable this plugin.
389389

390-
:::danger
390+
::: danger
391391
You should not configure it unless you understand what it is for.
392392
:::
393393

docs/reference/default-theme/components.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ npm install
9595
</CodeGroupItem>
9696
</CodeGroup>
9797

98-
:::warning
98+
::: warning
9999
You must add an empty line between the starting tag of `<CodeGroupItem>` and the code fence, otherwise the code fence will not be parsed correctly by Markdown.
100100

101101
All content must be valid Markdown first, and then a Vue SFC.

0 commit comments

Comments
 (0)