Add MkDocs configuration and tasks for local documentation setup via vscode run and debug (#7251)
silversword411 committed
Aug 29, 2025 at 05:10 UTC
3cf6b9334c62e37ada167d05ba454d82dd526291
3 files changed
+73
.vscode/launch.json
+10
@@ -10,6 +10,16 @@
10
"name": "Launch Chrome against localhost",
11
"url": "http://localhost:8080",
12
"webRoot": "${workspaceFolder}"
13
+ },
14
+ {
15
+ "name": "Test docs locally with mkdocs",
16
+ "type": "debugpy",
17
+ "request": "launch",
18
+ "program": "${workspaceFolder}/docs/env/Scripts/mkdocs.exe",
19
+ "args": ["serve", "--dev-addr", "127.0.0.1:8010"],
20
+ "cwd": "${workspaceFolder}/docs",
21
+ "console": "integratedTerminal",
22
+ "preLaunchTask": "Start MkDocs Server"
23
}
24
]
25
}
\ No newline at end of file
.vscode/tasks.json
new
+60
@@ -0,0 +1,60 @@
1
+{
2
+ "version": "2.0.0",
3
+ "tasks": [
4
+ {
5
+ "label": "Setup Python Environment",
6
+ "type": "shell",
7
+ "command": "python",
8
+ "args": ["-m", "venv", "env"],
9
+ "options": {
10
+ "cwd": "${workspaceFolder}/docs"
11
+ },
12
+ "group": "build",
13
+ "presentation": {
14
+ "echo": true,
15
+ "reveal": "always",
16
+ "focus": false,
17
+ "panel": "shared"
18
+ },
19
+ "problemMatcher": []
20
+ },
21
+ {
22
+ "label": "Install MkDocs Requirements",
23
+ "type": "shell",
24
+ "command": ".\\env\\Scripts\\activate.ps1; python -m pip install --upgrade pip; pip install -r requirements.txt",
25
+ "options": {
26
+ "cwd": "${workspaceFolder}/docs"
27
+ },
28
+ "group": "build",
29
+ "presentation": {
30
+ "echo": true,
31
+ "reveal": "always",
32
+ "focus": false,
33
+ "panel": "shared"
34
+ },
35
+ "problemMatcher": [],
36
+ "dependsOn": "Setup Python Environment"
37
+ },
38
+ {
39
+ "label": "Start MkDocs Server",
40
+ "type": "shell",
41
+ "command": ".\\env\\Scripts\\activate.ps1; Start-Process http://localhost:8010; mkdocs serve",
42
+ "options": {
43
+ "cwd": "${workspaceFolder}/docs"
44
+ },
45
+ "group": {
46
+ "kind": "build",
47
+ "isDefault": true
48
+ },
49
+ "presentation": {
50
+ "echo": true,
51
+ "reveal": "always",
52
+ "focus": false,
53
+ "panel": "shared"
54
+ },
55
+ "problemMatcher": [],
56
+ "isBackground": true,
57
+ "dependsOn": "Install MkDocs Requirements"
58
+ }
59
+ ]
60
+}
docs/requirements.txt
new
+3
@@ -0,0 +1,3 @@
1
+mkdocs>=1.5.0
2
+mkdocs-material>=9.0.0
3
+mkdocs-print-site-plugin>=2.3.0