Wiki Workflow Guide using VS Code - Arkthos/The-Escalation-Protocol GitHub Wiki
This guide outlines a structured workflow to manage and update a GitHub wiki using local editing, folder organization, sidebar generation, and automated git operations β all based on KCS (Knowledge-Centered Service) principles.
Last updated: June 27, 2025
- Node.js (Make sure to check βAdd to PATHβ during installation)
- Git installed and configured
- A local clone of your GitHub wiki repo (e.g.
your-repo.wiki.git
)
Clone the wiki:
git clone https://github.com/your-org/your-repo.wiki.git
Structure your Markdown files in meaningful folders:
π The-Escalation-Protocol.wiki/
βββ Getting-Started/
β βββ Home.md
βββ Defender for Endpoint/
β βββ Endpoint Detection and Response/
β βββ Alert Tuning/
β βββ Alert-Tuning-Quick-Start-Guide.md
...
Use markdown-file-tree
, which supports folders.
Install it globally:
npm install -g markdown-file-tree
Ensure C:\Users\<your-user>\AppData\Roaming\npm
is in your PATH
.
Run the following from the wiki root:
markdown-file-tree -f -o _Sidebar.md
This scans your folders and outputs a tree-structured sidebar markdown file.
You can use these commands to stage, commit, and push changes:
git add .
git commit -m "Update wiki content and sidebar"
git push
Automate the entire process by saving this to a file named push-wiki.ps1
:
markdown-file-tree -f -o _Sidebar.md
git add .
git commit -m "Update wiki content and sidebar"
git push
Then run with:
.\push-wiki.ps1
- Keep articles findable and consistent through folders.
- Use clear, concise titles for
.md
files. - Document fixes, procedures, or gotchas immediately after solving them.
- Periodically regenerate the sidebar to reflect structure accurately.
Task | Tool/Command |
---|---|
Clone wiki | git clone <wiki-url> |
Structure content | Folders + .md files |
Generate sidebar | markdown-file-tree -f -o _Sidebar.md |
Commit & push | git add . && git commit && git push |
Happy documenting! π