Skip to content

Commit f434551

Browse files
authored
完善一些文档语法风格 (#94)
* 完善一些文档语法风格 * 补充修改
1 parent 25db180 commit f434551

File tree

6 files changed

+108
-500
lines changed

6 files changed

+108
-500
lines changed

src/.vuepress/config.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@ export default defineUserConfig({
1515
},
1616

1717
theme,
18+
19+
markdown: {
20+
headers: {
21+
level: [2, 3, 4, 5],
22+
},
23+
},
24+
1825
plugins: [
1926
searchProPlugin({
2027
// 索引全部内容

src/.vuepress/sidebar/index.ts

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,7 @@ export const zhSidebar = sidebar({
1616
icon: "build",
1717
prefix: "contributing",
1818
collapsible: true,
19-
children: [
20-
"contributing",
21-
"markdown",
22-
"markdown-demo",
23-
"vscode-dev",
24-
"build",
25-
],
19+
children: ["contributing", "markdown", "vscode-dev", "build"],
2620
},
2721
],
2822
});

src/.vuepress/theme.ts

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ export default hopeTheme({
1919
docsDir: "src",
2020

2121
hotReload: true,
22+
2223
sidebarSorter: ["readme", "order", "filename", "title"],
24+
headerDepth: 4,
2325

2426
locales: {
2527
"/": {
@@ -57,7 +59,7 @@ export default hopeTheme({
5759
mdEnhance: {
5860
align: true,
5961
attrs: true,
60-
chart: true,
62+
// chart: true,
6163
checkLinks: {
6264
// 仅在开发模式下检查链接
6365
status: "always",
@@ -68,14 +70,14 @@ export default hopeTheme({
6870
"/playground.html",
6971
],
7072
},
71-
codetabs: true,
73+
// codetabs: true,
7274
// demo: true,
7375
// echarts: true,
7476
figure: true,
75-
flowchart: true,
76-
gfm: true,
77+
// flowchart: true,
78+
// gfm: true,
7779
imgLazyload: true,
78-
imgSize: true,
80+
// imgSize: true,
7981
include: true,
8082
katex: true,
8183
mark: true,

src/contributing/contributing.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 贡献指南
33
icon: build
44
date: 2023-07-20 23:05:53
5-
updated: 2023-07-21 11:56:02
5+
updated: 2023-11-23 22:56:02
66
---
77

88
# 贡献指南
@@ -28,9 +28,11 @@ Zotero 中文文档接受多种形式的贡献,请阅读这一份指南,以
2828

2929
## 提交 / 参与议题 / 讨论
3030

31-
:::note
31+
读者可以在前述的几种途径参与讨论。
3232

33-
读者需要一个 GitHub 账户才能提交发起或参与 ISSUE 讨论。
33+
::: note
34+
35+
读者需要一个 GitHub 账户才能提交发起或参与讨论。
3436

3537
:::
3638

@@ -40,13 +42,7 @@ Zotero 中文文档接受多种形式的贡献,请阅读这一份指南,以
4042

4143
若需要对文档做大量修改,可在经过讨论后,选择 [线下修改](build.md)
4244

43-
:::note
44-
45-
若不熟悉 Markdown 标记语言,可以参考 [Markdown 语法指南](markdown.md)
46-
47-
:::
48-
49-
:::note
45+
::: note
5046

5147
文档源码开源托管在 [GitHub](https://github.com/) 上,因此读者需要一个 GitHub 账户才能提交 PR。
5248

0 commit comments

Comments
 (0)