Skip to content

Commit ac21309

Browse files
committed
docs: change delimiters for attrs
1 parent 6ce186f commit ac21309

22 files changed

+187
-153
lines changed

package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"devDependencies": {
2323
"@rollup/plugin-alias": "^3.1.8",
2424
"@rollup/plugin-commonjs": "^21.0.1",
25-
"@rollup/plugin-node-resolve": "^13.0.6",
25+
"@rollup/plugin-node-resolve": "^13.2.0",
2626
"@rollup/plugin-replace": "^3.0.0",
2727
"@sucrase/jest-plugin": "^2.2.0",
2828
"@types/jest": "^27.0.3",
@@ -41,14 +41,14 @@
4141
"minimist": "^1.2.5",
4242
"p-series": "^3.0.0",
4343
"pascalcase": "^1.0.0",
44-
"prettier": "^2.5.1",
44+
"prettier": "^2.6.2",
4545
"rimraf": "^3.0.2",
4646
"rollup": "^2.61.1",
4747
"rollup-plugin-terser": "^7.0.2",
4848
"rollup-plugin-typescript2": "^0.31.1",
49-
"semver": "^7.3.5",
50-
"typedoc": "^0.22.13",
51-
"typedoc-plugin-markdown": "^3.11.7",
49+
"semver": "^7.3.6",
50+
"typedoc": "^0.22.15",
51+
"typedoc-plugin-markdown": "^3.12.0",
5252
"typescript": "^4.5.3",
5353
"yorkie": "^2.0.0"
5454
},

packages/docs/.vitepress/config.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,12 @@ const productionHead = [
2626
* @type {import('vitepress').UserConfig}
2727
*/
2828
module.exports = {
29+
markdown: {
30+
attrs: {
31+
leftDelimiter: '%{',
32+
rightDelimiter: '}%',
33+
},
34+
},
2935
title: 'Pinia',
3036
lang: 'en-US',
3137
description: 'The Vue Store that you will enjoy using',

packages/docs/api/enums/pinia.MutationType.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Direct mutation of the state:
2626

2727
#### Defined in
2828

29-
[pinia/src/types.ts:50](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L50)
29+
[pinia/src/types.ts:50](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L50)
3030

3131
___
3232

@@ -40,7 +40,7 @@ Mutated the state with `$patch` and a function
4040

4141
#### Defined in
4242

43-
[pinia/src/types.ts:64](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L64)
43+
[pinia/src/types.ts:64](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L64)
4444

4545
___
4646

@@ -54,4 +54,4 @@ Mutated the state with `$patch` and an object
5454

5555
#### Defined in
5656

57-
[pinia/src/types.ts:57](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L57)
57+
[pinia/src/types.ts:57](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L57)

packages/docs/api/interfaces/pinia.DefineSetupStoreOptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,4 @@ store defined with a setup function. Note this is always defined
4040

4141
#### Defined in
4242

43-
[pinia/src/types.ts:704](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L704)
43+
[pinia/src/types.ts:704](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L704)

packages/docs/api/interfaces/pinia.DefineStoreOptions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Optional object of actions.
3838

3939
#### Defined in
4040

41-
[pinia/src/types.ts:652](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L652)
41+
[pinia/src/types.ts:652](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L652)
4242

4343
___
4444

@@ -50,7 +50,7 @@ Optional object of getters.
5050

5151
#### Defined in
5252

53-
[pinia/src/types.ts:645](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L645)
53+
[pinia/src/types.ts:645](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L645)
5454

5555
___
5656

@@ -62,7 +62,7 @@ Unique string key to identify the store across the application.
6262

6363
#### Defined in
6464

65-
[pinia/src/types.ts:634](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L634)
65+
[pinia/src/types.ts:634](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L634)
6666

6767
## Methods
6868

@@ -103,7 +103,7 @@ const useStore = defineStore('main', {
103103

104104
#### Defined in
105105

106-
[pinia/src/types.ts:685](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L685)
106+
[pinia/src/types.ts:685](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L685)
107107

108108
___
109109

@@ -120,4 +120,4 @@ correct typings!
120120

121121
#### Defined in
122122

123-
[pinia/src/types.ts:640](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L640)
123+
[pinia/src/types.ts:640](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L640)

packages/docs/api/interfaces/pinia.DefineStoreOptionsInPlugin.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Defaults to an empty object if no actions are defined.
3939

4040
#### Defined in
4141

42-
[pinia/src/types.ts:721](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L721)
42+
[pinia/src/types.ts:721](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L721)
4343

4444
___
4545

@@ -55,7 +55,7 @@ Omit.getters
5555

5656
#### Defined in
5757

58-
[pinia/src/types.ts:645](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L645)
58+
[pinia/src/types.ts:645](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L645)
5959

6060
## Methods
6161

@@ -100,7 +100,7 @@ Omit.hydrate
100100

101101
#### Defined in
102102

103-
[pinia/src/types.ts:685](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L685)
103+
[pinia/src/types.ts:685](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L685)
104104

105105
___
106106

@@ -121,4 +121,4 @@ Omit.state
121121

122122
#### Defined in
123123

124-
[pinia/src/types.ts:640](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L640)
124+
[pinia/src/types.ts:640](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L640)

packages/docs/api/interfaces/pinia.Pinia.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ root state
2828

2929
#### Defined in
3030

31-
[pinia/src/rootStore.ts:51](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L51)
31+
[pinia/src/rootStore.ts:51](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L51)
3232

3333
## Methods
3434

@@ -48,7 +48,7 @@ root state
4848

4949
#### Defined in
5050

51-
[pinia/src/rootStore.ts:46](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L46)
51+
[pinia/src/rootStore.ts:46](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L46)
5252

5353
___
5454

@@ -70,4 +70,4 @@ Adds a store plugin to extend every store
7070

7171
#### Defined in
7272

73-
[pinia/src/rootStore.ts:58](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L58)
73+
[pinia/src/rootStore.ts:58](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L58)

packages/docs/api/interfaces/pinia.PiniaCustomProperties.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Nuxt context.
3131

3232
#### Defined in
3333

34-
[nuxt/src/module.ts:68](https://github.com/vuejs/pinia/blob/d96dca2/packages/nuxt/src/module.ts#L68)
34+
[nuxt/src/module.ts:68](https://github.com/vuejs/pinia/blob/6ce186f/packages/nuxt/src/module.ts#L68)
3535

3636
___
3737

@@ -41,7 +41,7 @@ ___
4141

4242
#### Defined in
4343

44-
[pinia/__tests__/storePlugins.spec.ts:14](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/__tests__/storePlugins.spec.ts#L14)
44+
[pinia/__tests__/storePlugins.spec.ts:14](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/__tests__/storePlugins.spec.ts#L14)
4545

4646
___
4747

@@ -51,7 +51,7 @@ ___
5151

5252
#### Defined in
5353

54-
[pinia/__tests__/storePlugins.spec.ts:11](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/__tests__/storePlugins.spec.ts#L11)
54+
[pinia/__tests__/storePlugins.spec.ts:11](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/__tests__/storePlugins.spec.ts#L11)
5555

5656
___
5757

@@ -61,7 +61,7 @@ ___
6161

6262
#### Defined in
6363

64-
[pinia/__tests__/storePlugins.spec.ts:12](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/__tests__/storePlugins.spec.ts#L12)
64+
[pinia/__tests__/storePlugins.spec.ts:12](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/__tests__/storePlugins.spec.ts#L12)
6565

6666
___
6767

@@ -71,7 +71,7 @@ ___
7171

7272
#### Defined in
7373

74-
[pinia/__tests__/storePlugins.spec.ts:9](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/__tests__/storePlugins.spec.ts#L9)
74+
[pinia/__tests__/storePlugins.spec.ts:9](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/__tests__/storePlugins.spec.ts#L9)
7575

7676
___
7777

@@ -81,7 +81,7 @@ ___
8181

8282
#### Defined in
8383

84-
[pinia/__tests__/storePlugins.spec.ts:10](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/__tests__/storePlugins.spec.ts#L10)
84+
[pinia/__tests__/storePlugins.spec.ts:10](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/__tests__/storePlugins.spec.ts#L10)
8585

8686
___
8787

@@ -91,7 +91,7 @@ ___
9191

9292
#### Defined in
9393

94-
[pinia/__tests__/storePlugins.spec.ts:7](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/__tests__/storePlugins.spec.ts#L7)
94+
[pinia/__tests__/storePlugins.spec.ts:7](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/__tests__/storePlugins.spec.ts#L7)
9595

9696
___
9797

@@ -101,7 +101,7 @@ ___
101101

102102
#### Defined in
103103

104-
[pinia/__tests__/storePlugins.spec.ts:13](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/__tests__/storePlugins.spec.ts#L13)
104+
[pinia/__tests__/storePlugins.spec.ts:13](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/__tests__/storePlugins.spec.ts#L13)
105105

106106
___
107107

@@ -111,7 +111,7 @@ ___
111111

112112
#### Defined in
113113

114-
[pinia/__tests__/storePlugins.spec.ts:8](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/__tests__/storePlugins.spec.ts#L8)
114+
[pinia/__tests__/storePlugins.spec.ts:8](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/__tests__/storePlugins.spec.ts#L8)
115115

116116
## Accessors
117117

@@ -125,7 +125,7 @@ ___
125125

126126
#### Defined in
127127

128-
[playground/src/main.ts:17](https://github.com/vuejs/pinia/blob/d96dca2/packages/playground/src/main.ts#L17)
128+
[playground/src/main.ts:17](https://github.com/vuejs/pinia/blob/6ce186f/packages/playground/src/main.ts#L17)
129129

130130
`set` **route**(`value`): `void`
131131

@@ -141,4 +141,4 @@ ___
141141

142142
#### Defined in
143143

144-
[playground/src/main.ts:14](https://github.com/vuejs/pinia/blob/d96dca2/packages/playground/src/main.ts#L14)
144+
[playground/src/main.ts:14](https://github.com/vuejs/pinia/blob/6ce186f/packages/playground/src/main.ts#L14)

packages/docs/api/interfaces/pinia.PiniaPlugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ nothing.
3131

3232
#### Defined in
3333

34-
[pinia/src/rootStore.ts:140](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L140)
34+
[pinia/src/rootStore.ts:140](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L140)

packages/docs/api/interfaces/pinia.PiniaPluginContext.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Current app created with `Vue.createApp()`.
3131

3232
#### Defined in
3333

34-
[pinia/src/rootStore.ts:117](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L117)
34+
[pinia/src/rootStore.ts:117](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L117)
3535

3636
___
3737

@@ -43,7 +43,7 @@ Current store being extended.
4343

4444
#### Defined in
4545

46-
[pinia/src/rootStore.ts:127](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L127)
46+
[pinia/src/rootStore.ts:127](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L127)
4747

4848
___
4949

@@ -55,7 +55,7 @@ pinia instance.
5555

5656
#### Defined in
5757

58-
[pinia/src/rootStore.ts:112](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L112)
58+
[pinia/src/rootStore.ts:112](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L112)
5959

6060
___
6161

@@ -67,4 +67,4 @@ Current store being extended.
6767

6868
#### Defined in
6969

70-
[pinia/src/rootStore.ts:122](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L122)
70+
[pinia/src/rootStore.ts:122](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L122)

0 commit comments

Comments
 (0)