create-vuepress-theme-plume 1.0.0-rc.91

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +14 -0
  3. package/bin/index.js +2 -0
  4. package/lib/index.d.ts +2 -0
  5. package/lib/index.js +506 -0
  6. package/package.json +43 -0
  7. package/templates/.vuepress/client.ts.handlebars +12 -0
  8. package/templates/.vuepress/config.ts.handlebars +90 -0
  9. package/templates/.vuepress/navbar.ts.handlebars +28 -0
  10. package/templates/.vuepress/notes.ts.handlebars +32 -0
  11. package/templates/.vuepress/plume.config.ts.handlebars +57 -0
  12. package/templates/.vuepress/public/plume.svg +8 -0
  13. package/templates/.vuepress/theme/components/Custom.vue +11 -0
  14. package/templates/.vuepress/theme/shim.d.ts +6 -0
  15. package/templates/.vuepress/theme/styles/custom.css +50 -0
  16. package/templates/common/README.md.handlebars +57 -0
  17. package/templates/common/README.zh-CN.md.handlebars +57 -0
  18. package/templates/deploy/github/.github/workflows/deploy.yml.handlebars +70 -0
  19. package/templates/deploy/netlify/netlify.toml.handlebars +9 -0
  20. package/templates/deploy/vercel/vercel.json.handlebars +6 -0
  21. package/templates/docs/en/README.md.handlebars +22 -0
  22. package/templates/docs/en/notes/demo/README.md +6 -0
  23. package/templates/docs/en/notes/demo/bar.md +5 -0
  24. package/templates/docs/en/notes/demo/foo.md +5 -0
  25. package/templates/docs/en/preview/custom-component.example.md +8 -0
  26. package/templates/docs/en/preview/markdown.md +312 -0
  27. package/templates/docs/zh/README.md.handlebars +22 -0
  28. package/templates/docs/zh/notes/demo/README.md +6 -0
  29. package/templates/docs/zh/notes/demo/bar.md +5 -0
  30. package/templates/docs/zh/notes/demo/foo.md +5 -0
  31. package/templates/docs/zh/preview/custom-component.example.md +8 -0
  32. package/templates/docs/zh/preview/markdown.md +312 -0
  33. package/templates/git/.gitattributes.handlebars +10 -0
  34. package/templates/git/.gitignore.handlebars +8 -0
@@ -0,0 +1,312 @@
1
+ ---
2
+ title: Markdown
3
+ tags:
4
+ - markdown
5
+ ---
6
+
7
+ ## Heading 2
8
+
9
+ ### Heading 3
10
+
11
+ #### Heading 4
12
+
13
+ ##### Heading 5
14
+
15
+ ###### Heading 6
16
+
17
+ Bold: **Bold text**
18
+
19
+ Italic: _Italic text_
20
+
21
+ ~~Deleted text~~
22
+
23
+ Content ==Highlight==
24
+
25
+ Mathematical expression: $-(2^{n-1})$ ~ $2^{n-1} -1$
26
+
27
+ $\frac {\partial^r} {\partial \omega^r} \left(\frac {y^{\omega}} {\omega}\right)
28
+ = \left(\frac {y^{\omega}} {\omega}\right) \left\{(\log y)^r + \sum_{i=1}^r \frac {(-1)^ Ir \cdots (r-i+1) (\log y)^{ri}} {\omega^i} \right\}$
29
+
30
+ 19^th^
31
+
32
+ H~2~O
33
+
34
+ ::: center
35
+ content center
36
+ :::
37
+
38
+ ::: right
39
+ content right
40
+ :::
41
+
42
+ - Unordered List 1
43
+ - Unordered List 2
44
+ - Unordered List 3
45
+
46
+ 1. Ordered List 1
47
+ 2. Ordered List 2
48
+ 3. Ordered List 3
49
+
50
+ - [ ] Task List 1
51
+ - [ ] Task List 2
52
+ - [x] Task List 3
53
+ - [x] Task List 4
54
+
55
+ | Tables | Are | Cool |
56
+ | ------------- |:-------------:| -----:|
57
+ | col 3 is | right-aligned | $1600 |
58
+ | col 2 is | centered | $12 |
59
+ | zebra stripes | are neat | $1 |
60
+
61
+ > quote content
62
+ >
63
+ > quote content
64
+
65
+ [links](/)
66
+
67
+ [outside links](https://github.com/pengzhanbo)
68
+
69
+ **Badge:**
70
+
71
+ - <Badge type="info" text="info badge" />
72
+ - <Badge type="tip" text="tip badge" />
73
+ - <Badge type="warning" text="warning badge" />
74
+ - <Badge type="danger" text="danger badge" />
75
+
76
+ **icons:**
77
+
78
+ - home - <Icon name="material-symbols:home" color="currentColor" size="1em" />
79
+ - vscode - <Icon name="skill-icons:vscode-dark" size="2em" />
80
+ - twitter - <Icon name="skill-icons:twitter" size="2em" />
81
+
82
+ **demo wrapper:**
83
+
84
+ ::: demo-wrapper title="Demo" no-padding height="200px"
85
+ <style scoped>
86
+ .open-door {
87
+ display: flex;
88
+ gap: 20px;
89
+ padding: 20px;
90
+ }
91
+ .open-door .main {
92
+ background: #ccc;
93
+ }
94
+ </style>
95
+
96
+ <div class="open-door">
97
+ <div class="main">main</div>
98
+ <div class="aside">aside</div>
99
+ </div>
100
+
101
+ :::
102
+
103
+ **code block:**
104
+
105
+ ```js whitespace
106
+ const a = 1
107
+ const b = 2
108
+ const c = a + b
109
+
110
+ // [!code word:obj]
111
+ const obj = {
112
+ toLong: {
113
+ deep: {
114
+ deep: {
115
+ deep: {
116
+ value: 'this is to long text. this is to long text. this is to long text. this is to long text.', // [!code highlight]
117
+ }
118
+ }
119
+ }
120
+ }
121
+ }
122
+ ```
123
+
124
+ **code groups:**
125
+
126
+ ::: code-tabs
127
+ @tab tab1
128
+
129
+ ```js
130
+ const a = 1
131
+ const b = 2
132
+ const c = a + b
133
+ ```
134
+
135
+ @tab tab2
136
+
137
+ ```ts
138
+ const a: number = 1
139
+ const b: number = 2
140
+ const c: number = a + b
141
+ ```
142
+
143
+ :::
144
+
145
+ **code highlight:**
146
+
147
+ ```ts
148
+ function foo() {
149
+ const a = 1 // [!code highlight]
150
+
151
+ console.log(a)
152
+
153
+ const b = 2 // [!code ++]
154
+ const c = 3 // [!code --]
155
+
156
+ console.log(a + b + c) // [!code error]
157
+ console.log(a + b) // [!code warning]
158
+ }
159
+ ```
160
+
161
+ **code focus:**
162
+
163
+ ```ts
164
+ function foo() {
165
+ const a = 1 // [!code focus]
166
+ }
167
+ ```
168
+
169
+ ::: note
170
+ note content [link](https://github.com/pengzhanbo) `inline code`
171
+
172
+ ```js
173
+ const a = 1
174
+ const b = 2
175
+ const c = a + b
176
+ ```
177
+
178
+ :::
179
+
180
+ ::: info
181
+ content [link](https://github.com/pengzhanbo) `inline code`
182
+
183
+ ```js
184
+ const a = 1
185
+ const b = 2
186
+ const c = a + b
187
+ ```
188
+
189
+ :::
190
+
191
+ ::: tip
192
+ content [link](https://github.com/pengzhanbo) `inline code`
193
+
194
+ ```js
195
+ const a = 1
196
+ const b = 2
197
+ const c = a + b
198
+ ```
199
+
200
+ :::
201
+
202
+ ::: warning
203
+ content [link](https://github.com/pengzhanbo) `inline code`
204
+
205
+ ```js
206
+ const a = 1
207
+ const b = 2
208
+ const c = a + b
209
+ ```
210
+
211
+ :::
212
+
213
+ ::: caution
214
+ content [link](https://github.com/pengzhanbo) `inline code`
215
+
216
+ ```js
217
+ const a = 1
218
+ const b = 2
219
+ const c = a + b
220
+ ```
221
+
222
+ :::
223
+
224
+ ::: important
225
+ content [link](https://github.com/pengzhanbo) `inline code`
226
+
227
+ ```js
228
+ const a = 1
229
+ const b = 2
230
+ const c = a + b
231
+ ```
232
+
233
+ :::
234
+
235
+ **GFM alert:**
236
+
237
+ > [!note]
238
+ > note
239
+
240
+ > [!info]
241
+ > info
242
+
243
+ > [!tip]
244
+ > tip
245
+
246
+ > [!warning]
247
+ > warning
248
+
249
+ > [!caution]
250
+ > caution
251
+
252
+ > [!important]
253
+ > important
254
+
255
+ **code demo:**
256
+
257
+ ::: normal-demo Demo 演示
258
+
259
+ ```html
260
+ <h1>Hello Word!</h1>
261
+ <p><span id="very">Very</span>Powerful!</p>
262
+ ```
263
+
264
+ ```js
265
+ document.querySelector('#very').addEventListener('click', () => {
266
+ alert('Very Powerful')
267
+ })
268
+ ```
269
+
270
+ ```css
271
+ span {
272
+ color: red;
273
+ }
274
+ ```
275
+
276
+ :::
277
+
278
+ **tab card:**
279
+
280
+ ::: tabs
281
+ @tab title 1
282
+ content block
283
+
284
+ @tab title 2
285
+ content block
286
+ :::
287
+
288
+ :::: warning
289
+ ::: tabs
290
+ @tab title 1
291
+ content block
292
+
293
+ @tab title 2
294
+ content block
295
+ :::
296
+ ::::
297
+
298
+ **footnote:**
299
+
300
+ footnote 1 link[^first]。
301
+
302
+ footnote 2 link[^second]。
303
+
304
+ inline footnote ^[^first] definition。
305
+
306
+ Repeated footnote definition[^second]。
307
+
308
+ [^first]: footnote **you can contain special mark**
309
+
310
+ also can contain paragraph
311
+
312
+ [^second]: footnote content.
@@ -0,0 +1,22 @@
1
+ ---
2
+ pageLayout: home
3
+ externalLinkIcon: false
4
+ config:
5
+ -
6
+ type: hero
7
+ full: true
8
+ background: tint-plate
9
+ hero:
10
+ name: Theme Plume
11
+ tagline: VuePress Next Theme
12
+ text: 一个简约的,功能丰富的 vuepress 文档&博客 主题
13
+ actions:
14
+ -
15
+ theme: brand
16
+ text: 博客
17
+ link: {{#if (equal defaultLanguage 'zh-CN')}}/{{else}}/zh/{{/if}}blog/
18
+ -
19
+ theme: alt
20
+ text: Github →
21
+ link: https://github.com/pengzhanbo/vuepress-theme-plume
22
+ ---
@@ -0,0 +1,6 @@
1
+ ---
2
+ title: Demo
3
+ ---
4
+
5
+ - [bar](./bar.md)
6
+ - [foo](./foo.md)
@@ -0,0 +1,5 @@
1
+ ---
2
+ title: bar
3
+ ---
4
+
5
+ [foo](./foo.md)
@@ -0,0 +1,5 @@
1
+ ---
2
+ title: foo
3
+ ---
4
+
5
+ [bar](./bar.md)
@@ -0,0 +1,8 @@
1
+ ---
2
+ title: 自定义组件
3
+ tags:
4
+ - 预览
5
+ - 组件
6
+ ---
7
+
8
+ <CustomComponent />
@@ -0,0 +1,312 @@
1
+ ---
2
+ title: Markdown
3
+ tags:
4
+ - markdown
5
+ ---
6
+
7
+ ## 标题 2
8
+
9
+ ### 标题 3
10
+
11
+ #### 标题 4
12
+
13
+ ##### 标题 5
14
+
15
+ ###### 标题 6
16
+
17
+ 加粗:**加粗文字**
18
+
19
+ 斜体: _斜体文字_
20
+
21
+ ~~删除文字~~
22
+
23
+ 内容 ==标记==
24
+
25
+ 数学表达式: $-(2^{n-1})$ ~ $2^{n-1} -1$
26
+
27
+ $\frac {\partial^r} {\partial \omega^r} \left(\frac {y^{\omega}} {\omega}\right)
28
+ = \left(\frac {y^{\omega}} {\omega}\right) \left\{(\log y)^r + \sum_{i=1}^r \frac {(-1)^ Ir \cdots (r-i+1) (\log y)^{ri}} {\omega^i} \right\}$
29
+
30
+ 19^th^
31
+
32
+ H~2~O
33
+
34
+ ::: center
35
+ 内容居中
36
+ :::
37
+
38
+ ::: right
39
+ 内容右对齐
40
+ :::
41
+
42
+ - 无序列表1
43
+ - 无序列表2
44
+ - 无序列表3
45
+
46
+ 1. 有序列表1
47
+ 2. 有序列表2
48
+ 3. 有序列表3
49
+
50
+ - [ ] 任务列表1
51
+ - [ ] 任务列表2
52
+ - [x] 任务列表3
53
+ - [x] 任务列表4
54
+
55
+ | Tables | Are | Cool |
56
+ | ------------- |:-------------:| -----:|
57
+ | col 3 is | right-aligned | $1600 |
58
+ | col 2 is | centered | $12 |
59
+ | zebra stripes | are neat | $1 |
60
+
61
+ > 引用内容
62
+ >
63
+ > 引用内容
64
+
65
+ [链接](/)
66
+
67
+ [外部链接](https://github.com/pengzhanbo)
68
+
69
+ **Badge:**
70
+
71
+ - <Badge type="info" text="info badge" />
72
+ - <Badge type="tip" text="tip badge" />
73
+ - <Badge type="warning" text="warning badge" />
74
+ - <Badge type="danger" text="danger badge" />
75
+
76
+ **图标:**
77
+
78
+ - home - <Icon name="material-symbols:home" color="currentColor" size="1em" />
79
+ - vscode - <Icon name="skill-icons:vscode-dark" size="2em" />
80
+ - twitter - <Icon name="skill-icons:twitter" size="2em" />
81
+
82
+ **demo wrapper:**
83
+
84
+ ::: demo-wrapper title="示例" no-padding height="200px"
85
+ <style scoped>
86
+ .open-door {
87
+ display: flex;
88
+ gap: 20px;
89
+ padding: 20px;
90
+ }
91
+ .open-door .main {
92
+ background: #ccc;
93
+ }
94
+ </style>
95
+
96
+ <div class="open-door">
97
+ <div class="main">main</div>
98
+ <div class="aside">aside</div>
99
+ </div>
100
+
101
+ :::
102
+
103
+ **代码:**
104
+
105
+ ```js whitespace
106
+ const a = 1
107
+ const b = 2
108
+ const c = a + b
109
+
110
+ // [!code word:obj]
111
+ const obj = {
112
+ toLong: {
113
+ deep: {
114
+ deep: {
115
+ deep: {
116
+ value: 'this is to long text. this is to long text. this is to long text. this is to long text.', // [!code highlight]
117
+ }
118
+ }
119
+ }
120
+ }
121
+ }
122
+ ```
123
+
124
+ **代码分组:**
125
+
126
+ ::: code-tabs
127
+ @tab tab1
128
+
129
+ ```js
130
+ const a = 1
131
+ const b = 2
132
+ const c = a + b
133
+ ```
134
+
135
+ @tab tab2
136
+
137
+ ```ts
138
+ const a: number = 1
139
+ const b: number = 2
140
+ const c: number = a + b
141
+ ```
142
+
143
+ :::
144
+
145
+ **代码块高亮:**
146
+
147
+ ```ts
148
+ function foo() {
149
+ const a = 1 // [!code highlight]
150
+
151
+ console.log(a)
152
+
153
+ const b = 2 // [!code ++]
154
+ const c = 3 // [!code --]
155
+
156
+ console.log(a + b + c) // [!code error]
157
+ console.log(a + b) // [!code warning]
158
+ }
159
+ ```
160
+
161
+ **代码块聚焦:**
162
+
163
+ ```ts
164
+ function foo() {
165
+ const a = 1 // [!code focus]
166
+ }
167
+ ```
168
+
169
+ ::: note 注释
170
+ 注释内容 [link](https://github.com/pengzhanbo) `inline code`
171
+
172
+ ```js
173
+ const a = 1
174
+ const b = 2
175
+ const c = a + b
176
+ ```
177
+
178
+ :::
179
+
180
+ ::: info 信息
181
+ 信息内容 [link](https://github.com/pengzhanbo) `inline code`
182
+
183
+ ```js
184
+ const a = 1
185
+ const b = 2
186
+ const c = a + b
187
+ ```
188
+
189
+ :::
190
+
191
+ ::: tip 提示
192
+ 提示内容 [link](https://github.com/pengzhanbo) `inline code`
193
+
194
+ ```js
195
+ const a = 1
196
+ const b = 2
197
+ const c = a + b
198
+ ```
199
+
200
+ :::
201
+
202
+ ::: warning 警告
203
+ 警告内容 [link](https://github.com/pengzhanbo) `inline code`
204
+
205
+ ```js
206
+ const a = 1
207
+ const b = 2
208
+ const c = a + b
209
+ ```
210
+
211
+ :::
212
+
213
+ ::: caution 错误
214
+ 错误内容 [link](https://github.com/pengzhanbo) `inline code`
215
+
216
+ ```js
217
+ const a = 1
218
+ const b = 2
219
+ const c = a + b
220
+ ```
221
+
222
+ :::
223
+
224
+ ::: important 重要
225
+ 重要内容 [link](https://github.com/pengzhanbo) `inline code`
226
+
227
+ ```js
228
+ const a = 1
229
+ const b = 2
230
+ const c = a + b
231
+ ```
232
+
233
+ :::
234
+
235
+ **GFM alert:**
236
+
237
+ > [!note]
238
+ > note
239
+
240
+ > [!info]
241
+ > info
242
+
243
+ > [!tip]
244
+ > tip
245
+
246
+ > [!warning]
247
+ > warning
248
+
249
+ > [!caution]
250
+ > caution
251
+
252
+ > [!important]
253
+ > important
254
+
255
+ **代码演示:**
256
+
257
+ ::: normal-demo Demo 演示
258
+
259
+ ```html
260
+ <h1>Hello Word!</h1>
261
+ <p><span id="very">非常</span>强大!</p>
262
+ ```
263
+
264
+ ```js
265
+ document.querySelector('#very').addEventListener('click', () => {
266
+ alert('非常强大')
267
+ })
268
+ ```
269
+
270
+ ```css
271
+ span {
272
+ color: red;
273
+ }
274
+ ```
275
+
276
+ :::
277
+
278
+ **选项卡:**
279
+
280
+ ::: tabs
281
+ @tab 标题1
282
+ 内容区块
283
+
284
+ @tab 标题2
285
+ 内容区块
286
+ :::
287
+
288
+ :::: warning
289
+ ::: tabs
290
+ @tab 标题1
291
+ 内容区块
292
+
293
+ @tab 标题2
294
+ 内容区块
295
+ :::
296
+ ::::
297
+
298
+ **脚注:**
299
+
300
+ 脚注 1 链接[^first]。
301
+
302
+ 脚注 2 链接[^second]。
303
+
304
+ 行内的脚注^[行内脚注文本] 定义。
305
+
306
+ 重复的页脚定义[^second]。
307
+
308
+ [^first]: 脚注 **可以包含特殊标记**
309
+
310
+ 也可以由多个段落组成
311
+
312
+ [^second]: 脚注文字。
@@ -0,0 +1,10 @@
1
+ * text eol=lf
2
+ *.txt text eol=crlf
3
+
4
+ *.png binary
5
+ *.jpg binary
6
+ *.jpeg binary
7
+ *.ico binary
8
+ *.tff binary
9
+ *.woff binary
10
+ *.woff2 binary
@@ -0,0 +1,8 @@
1
+ node_modules
2
+
3
+ {{ docsDir }}/.vuepress/.cache
4
+ {{ docsDir }}/.vuepress/.temp
5
+ {{ docsDir }}/.vuepress/dist
6
+
7
+ .DS_Store
8
+ *.log