mirror of
https://github.com/Ylianst/MeshCentral.git
synced 2025-10-28 23:05:01 -04:00
Add MkDocs configuration and tasks for local documentation setup via vscode run and debug (#7251)
This commit is contained in:
parent
d2433cb250
commit
3cf6b9334c
10
.vscode/launch.json
vendored
10
.vscode/launch.json
vendored
@ -10,6 +10,16 @@
|
||||
"name": "Launch Chrome against localhost",
|
||||
"url": "http://localhost:8080",
|
||||
"webRoot": "${workspaceFolder}"
|
||||
},
|
||||
{
|
||||
"name": "Test docs locally with mkdocs",
|
||||
"type": "debugpy",
|
||||
"request": "launch",
|
||||
"program": "${workspaceFolder}/docs/env/Scripts/mkdocs.exe",
|
||||
"args": ["serve", "--dev-addr", "127.0.0.1:8010"],
|
||||
"cwd": "${workspaceFolder}/docs",
|
||||
"console": "integratedTerminal",
|
||||
"preLaunchTask": "Start MkDocs Server"
|
||||
}
|
||||
]
|
||||
}
|
||||
60
.vscode/tasks.json
vendored
Normal file
60
.vscode/tasks.json
vendored
Normal file
@ -0,0 +1,60 @@
|
||||
{
|
||||
"version": "2.0.0",
|
||||
"tasks": [
|
||||
{
|
||||
"label": "Setup Python Environment",
|
||||
"type": "shell",
|
||||
"command": "python",
|
||||
"args": ["-m", "venv", "env"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}/docs"
|
||||
},
|
||||
"group": "build",
|
||||
"presentation": {
|
||||
"echo": true,
|
||||
"reveal": "always",
|
||||
"focus": false,
|
||||
"panel": "shared"
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Install MkDocs Requirements",
|
||||
"type": "shell",
|
||||
"command": ".\\env\\Scripts\\activate.ps1; python -m pip install --upgrade pip; pip install -r requirements.txt",
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}/docs"
|
||||
},
|
||||
"group": "build",
|
||||
"presentation": {
|
||||
"echo": true,
|
||||
"reveal": "always",
|
||||
"focus": false,
|
||||
"panel": "shared"
|
||||
},
|
||||
"problemMatcher": [],
|
||||
"dependsOn": "Setup Python Environment"
|
||||
},
|
||||
{
|
||||
"label": "Start MkDocs Server",
|
||||
"type": "shell",
|
||||
"command": ".\\env\\Scripts\\activate.ps1; Start-Process http://localhost:8010; mkdocs serve",
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}/docs"
|
||||
},
|
||||
"group": {
|
||||
"kind": "build",
|
||||
"isDefault": true
|
||||
},
|
||||
"presentation": {
|
||||
"echo": true,
|
||||
"reveal": "always",
|
||||
"focus": false,
|
||||
"panel": "shared"
|
||||
},
|
||||
"problemMatcher": [],
|
||||
"isBackground": true,
|
||||
"dependsOn": "Install MkDocs Requirements"
|
||||
}
|
||||
]
|
||||
}
|
||||
3
docs/requirements.txt
Normal file
3
docs/requirements.txt
Normal file
@ -0,0 +1,3 @@
|
||||
mkdocs>=1.5.0
|
||||
mkdocs-material>=9.0.0
|
||||
mkdocs-print-site-plugin>=2.3.0
|
||||
Loading…
x
Reference in New Issue
Block a user