Skip to content

Commit 6c2c6c1

Browse files
BlaxBerry333BlaxBerry333
committed
docs: update docs
1 parent 227a77a commit 6c2c6c1

File tree

50 files changed

+3635
-196
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+3635
-196
lines changed

‎docs/.vitepress/config/default-theme-config/default-theme-navbar/index.ts‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ import { PYTHON_ROOT } from "../default-theme-sidebar/web-backend/_python";
55
import { DJANGO_ROOT } from "../default-theme-sidebar/web-backend/_django";
66
import { REACT_JS_ROOT } from "../default-theme-sidebar/web-frontend/_react";
77
import { VUE_JS_ROOT } from "../default-theme-sidebar/web-frontend/_vue";
8-
import { GIT_ROOT } from "../default-theme-sidebar/dev-tools/_git";
8+
import { DOCKER_ROOT } from "../default-theme-sidebar/web-infrastructure/_docker";
9+
import { DEV_TOOLS_ROOT__GIT } from "../default-theme-sidebar/dev-tools";
910

1011
export const DEFAULT_THEME_NAVBAR: Array<DefaultTheme.NavItem> = [
1112
{
@@ -31,8 +32,8 @@ export const DEFAULT_THEME_NAVBAR: Array<DefaultTheme.NavItem> = [
3132
{
3233
text: "常用工具",
3334
items: [
34-
{ text: "Git", link: `${GIT_ROOT}/` },
35-
// { text: "Docker", link: `${DOCKER_ROOT}/` },
35+
{ text: "Git", link: `${DEV_TOOLS_ROOT__GIT}/` },
36+
{ text: "Docker", link: `${DOCKER_ROOT}/` },
3637
],
3738
},
3839
];

‎docs/.vitepress/config/default-theme-config/default-theme-sidebar/dev-tools/_git.ts‎

Lines changed: 0 additions & 25 deletions
This file was deleted.

‎docs/.vitepress/config/default-theme-config/default-theme-sidebar/dev-tools/index.ts‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
import { type DefaultTheme } from "vitepress";
2+
3+
export const DEV_TOOLS_ROOT = "/notes/dev-tools";
4+
export const DEV_TOOLS_ROOT__GIT = `${DEV_TOOLS_ROOT}/version/git`;
5+
export const DEV_TOOLS_ROOT__ASDF = `${DEV_TOOLS_ROOT}/version/asdf`;
6+
export const DEV_TOOLS_ROOT__MAKEFILE = `${DEV_TOOLS_ROOT}/auto-build/makefile`;
7+
export const DEV_TOOLS_ROOT__CURL = `${DEV_TOOLS_ROOT}/debugging/curl`;
8+
9+
export const DEV_TOOLS_SIDEBAR: Array<DefaultTheme.SidebarItem> = [
10+
{
11+
text: "版本控制工具",
12+
collapsed: false,
13+
items: [
14+
{
15+
text: "Git",
16+
link: `${DEV_TOOLS_ROOT__GIT}/`,
17+
},
18+
{
19+
text: "asdf",
20+
link: `${DEV_TOOLS_ROOT__ASDF}/`,
21+
},
22+
],
23+
},
24+
25+
{
26+
text: "自动构建工具",
27+
collapsed: false,
28+
items: [
29+
{
30+
text: "Makefile",
31+
link: `${DEV_TOOLS_ROOT__MAKEFILE}/`,
32+
},
33+
],
34+
},
35+
36+
{
37+
text: "调试分析工具",
38+
collapsed: false,
39+
items: [
40+
{
41+
text: "cRUL",
42+
link: `${DEV_TOOLS_ROOT__CURL}/`,
43+
},
44+
],
45+
},
46+
47+
{
48+
text: "返回首页",
49+
link: `${DEV_TOOLS_ROOT}/`,
50+
},
51+
];

‎docs/.vitepress/config/default-theme-config/default-theme-sidebar/index.ts‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ import { VUE_JS_ROOT, VUE_JS_SIDEBAR } from "./web-frontend/_vue";
1212
import { PYTHON_ROOT, PYTHON_SIDEBAR } from "./web-backend/_python";
1313
import { DJANGO_ROOT, DJANGO_SIDEBAR } from "./web-backend/_django";
1414

15+
// dev-tools
16+
// ------------------------------------------------------------------------------------------------------------------------
17+
18+
import { DEV_TOOLS_ROOT, DEV_TOOLS_SIDEBAR } from "./dev-tools";
19+
1520
export const DEFAULT_THEME_SIDEBAR: DefaultTheme.Sidebar = {
1621
/**
1722
* web-frontend
@@ -28,4 +33,10 @@ export const DEFAULT_THEME_SIDEBAR: DefaultTheme.Sidebar = {
2833
*/
2934
[PYTHON_ROOT]: PYTHON_SIDEBAR,
3035
[DJANGO_ROOT]: DJANGO_SIDEBAR,
36+
37+
/**
38+
* dev-tools
39+
* ------------------------------------------------------------------------------------------------------------------------
40+
*/
41+
[DEV_TOOLS_ROOT]: DEV_TOOLS_SIDEBAR,
3142
};

‎docs/.vitepress/config/default-theme-config/default-theme-sidebar/web-backend/_django.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,10 @@ export const DJANGO_SIDEBAR: Array<DefaultTheme.SidebarItem> = [
5454
text: "Django REST Framework",
5555
link: `${DJANGO_ROOT}/__extensions__/django-rest-framework`,
5656
},
57+
{
58+
text: "django-allauth",
59+
link: `https://zenn.dev/mom/books/4c7430e6a7b321/viewer/76c6b9`,
60+
},
5761
],
5862
},
5963

‎docs/.vitepress/config/default-theme-config/default-theme-sidebar/web-frontend/_javascript.ts‎

Lines changed: 38 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -7,64 +7,33 @@ export const JS_SIDEBAR: Array<DefaultTheme.SidebarItem> = [
77
text: "JavaScript 基础",
88
collapsed: false,
99
items: [
10-
{
11-
text: "变量与常量",
12-
link: `${JS_ROOT}/__base__/variable-constant`,
13-
},
14-
{
15-
text: "引用与拷贝",
16-
link: `${JS_ROOT}/__base__/data-reference-copy`,
17-
},
18-
{
19-
text: "数据类型操作",
20-
link: `${JS_ROOT}/__base__/data-types/type-operations`,
21-
},
2210
{
2311
text: "数据类型",
2412
collapsed: true,
2513
items: [
2614
{
27-
text: "值类型",
15+
text: "基本数据类型 ( 原始类型 )",
2816
collapsed: true,
29-
items: [
30-
{
31-
text: "数值 ( Number )",
32-
link: `${JS_ROOT}/__base__/data-types/value-types/number`,
33-
},
34-
{
35-
text: "布尔值 ( Boolean )",
36-
link: `${JS_ROOT}/__base__/data-types/value-types/boolean`,
37-
},
38-
{
39-
text: "字符串 ( String )",
40-
link: `${JS_ROOT}/__base__/data-types/value-types/string`,
41-
},
42-
{
43-
text: "符号 ( Symbol )",
44-
link: `${JS_ROOT}/__base__/data-types/value-types/symbol`,
45-
},
46-
{
47-
text: "空值、未定义",
48-
link: `${JS_ROOT}/__base__/data-types/value-types/null-undefined`,
49-
},
50-
],
17+
link: `${JS_ROOT}/__base__/data-types/primitive-types`,
5118
},
5219
{
53-
text: "引用类型",
54-
collapsed: true,
55-
items: [
56-
{
57-
text: "数组 ( Array )",
58-
link: `${JS_ROOT}/__base__/data-types/reference-types/array`,
59-
},
60-
{
61-
text: "对象 ( Object )",
62-
link: `${JS_ROOT}/__base__/data-types/reference-types/object`,
63-
},
64-
],
20+
text: "引用数据类型 ( 对象类型 )",
21+
link: `${JS_ROOT}/__base__/data-types/reference-types`,
22+
},
23+
{
24+
text: "类型操作",
25+
link: `${JS_ROOT}/__base__/data-types/type-operations`,
26+
},
27+
{
28+
text: "存储与拷贝",
29+
link: `${JS_ROOT}/__base__/data-storage-copy`,
6530
},
6631
],
6732
},
33+
{
34+
text: "变量与常量",
35+
link: `${JS_ROOT}/__base__/variable-constant`,
36+
},
6837
{
6938
text: "运算符",
7039
link: `${JS_ROOT}/__base__/operators`,
@@ -122,28 +91,28 @@ export const JS_SIDEBAR: Array<DefaultTheme.SidebarItem> = [
12291
],
12392
},
12493

125-
{
126-
text: "Web API",
127-
collapsed: false,
128-
items: [
129-
{
130-
text: "浏览器存储",
131-
link: `${JS_ROOT}/web-apis/browser-storage`,
132-
},
133-
{
134-
text: "网络请求",
135-
link: `${JS_ROOT}/web-apis/networking`,
136-
},
137-
{
138-
text: "DOM",
139-
link: `${JS_ROOT}/web-apis/dom`,
140-
},
141-
{
142-
text: "图像预览",
143-
link: `${JS_ROOT}/web-apis/image-preview`,
144-
},
145-
],
146-
},
94+
// {
95+
// text: "Web API",
96+
// collapsed: false,
97+
// items: [
98+
// {
99+
// text: "浏览器存储",
100+
// link: `${JS_ROOT}/web-apis/browser-storage`,
101+
// },
102+
// {
103+
// text: "网络请求",
104+
// link: `${JS_ROOT}/web-apis/networking`,
105+
// },
106+
// {
107+
// text: "DOM",
108+
// link: `${JS_ROOT}/web-apis/dom`,
109+
// },
110+
// {
111+
// text: "图像预览",
112+
// link: `${JS_ROOT}/web-apis/image-preview`,
113+
// },
114+
// ],
115+
// },
147116

148117
{
149118
text: "功能扩展",

‎docs/.vitepress/config/default-theme-config/default-theme-sidebar/web-frontend/_react.ts‎

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,40 @@ export const REACT_JS_SIDEBAR: Array<DefaultTheme.SidebarItem> = [
77
text: "React 基础",
88
collapsed: false,
99
items: [
10-
{
11-
text: "JSX / TSX",
12-
link: `${REACT_JS_ROOT}/__base__/jsx-tsx`,
13-
},
1410
{
1511
text: "组件基础",
16-
link: `${REACT_JS_ROOT}/__base__/component`,
12+
collapsed: true,
13+
items: [
14+
{
15+
text: "标签语法 ( JSX / TSX )",
16+
link: `${REACT_JS_ROOT}/__base__/components-jsx-tsx`,
17+
},
18+
{
19+
text: "组件间通信",
20+
link: `${REACT_JS_ROOT}/__base__/component-communication`,
21+
},
22+
{
23+
text: "组件样式",
24+
link: `${REACT_JS_ROOT}/__base__/component-styles`,
25+
},
26+
{
27+
text: "常用内置组件",
28+
link: `${REACT_JS_ROOT}/__base__/builtin-components`,
29+
},
30+
],
1731
},
1832
{
19-
text: "内置组件",
20-
link: `${REACT_JS_ROOT}/__base__/builtin-components`,
33+
text: "钩子函数 ( Hooks )",
34+
link: `${REACT_JS_ROOT}/__base__/hooks`,
2135
},
2236
{
23-
text: "内置函数",
37+
text: "常用内置函数",
2438
link: `${REACT_JS_ROOT}/__base__/builtin-functions`,
2539
},
26-
{
27-
text: "内置 Hooks",
28-
link: `${REACT_JS_ROOT}/__base__/builtin-hooks`,
29-
},
40+
// {
41+
// text: "TypeScript",
42+
// link: `${REACT_JS_ROOT}/__base__/typescript`,
43+
// },
3044
],
3145
},
3246

@@ -42,6 +56,10 @@ export const REACT_JS_SIDEBAR: Array<DefaultTheme.SidebarItem> = [
4256
text: "Redux Toolkit",
4357
link: `https://redux-toolkit.js.org/`,
4458
},
59+
{
60+
text: "React Hook Form",
61+
link: `https://www.react-hook-form.com/`,
62+
},
4563
{
4664
text: "TanStack Query",
4765
link: `https://tanstack.com/query/latest/docs/framework/react/overview`,

‎docs/.vitepress/config/default-theme-config/default-theme-sidebar/web-frontend/_vue.ts‎

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,46 @@ export const VUE_JS_SIDEBAR: Array<DefaultTheme.SidebarItem> = [
66
{
77
text: "Vue 基础",
88
collapsed: false,
9-
items: [],
9+
items: [
10+
{
11+
text: "组件基础",
12+
collapsed: true,
13+
items: [
14+
{
15+
text: "模版语法",
16+
link: `${VUE_JS_ROOT}/__base__/component-template-syntax`,
17+
},
18+
{
19+
text: "响应式数据",
20+
link: `${VUE_JS_ROOT}/__base__/component-reactive-data`,
21+
},
22+
{
23+
text: "组件间通信",
24+
link: `${VUE_JS_ROOT}/__base__/component-communication`,
25+
},
26+
{
27+
text: "组件样式",
28+
link: `${VUE_JS_ROOT}/__base__/component-styles`,
29+
},
30+
{
31+
text: "常用内置组件",
32+
link: `${VUE_JS_ROOT}/__base__/builtin-components`,
33+
},
34+
],
35+
},
36+
{
37+
text: "钩子函数 ( Hooks )",
38+
link: `${VUE_JS_ROOT}/__base__/hooks`,
39+
},
40+
{
41+
text: "常用内置函数",
42+
link: `${VUE_JS_ROOT}/__base__/builtin-functions`,
43+
},
44+
// {
45+
// text: "TypeScript",
46+
// link: `${REACT_JS_ROOT}/__base__/typescript`,
47+
// },
48+
],
1049
},
1150

1251
{

‎docs/.vitepress/config/default-theme-config/default-theme-sidebar/web-infrastructure/_docker.ts‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
import { type DefaultTheme } from "vitepress";
2+
3+
export const DOCKER_ROOT = "/notes/web-infrastructure/containerization/docker";
4+
5+
export const DOCKER_SIDEBAR: Array<DefaultTheme.SidebarItem> = [
6+
{
7+
text: "Docker 基础",
8+
collapsed: false,
9+
items: [],
10+
},
11+
12+
{
13+
text: "返回首页",
14+
link: `${DOCKER_ROOT}/`,
15+
},
16+
];

0 commit comments

Comments
 (0)