Git WiKi Sync
Effortlessly synchronize your project’s GitHub or GitLab Wiki with your local VS Code Folder.
Working Principle
This extension integrates GitHub/GitLab Wiki repositories into project management using Git Submodule mechanism, providing the following core benefits:
Document and Code Co-viewing - Wiki content is embedded as a submodule, allowing simultaneous viewing of code and documentation in the same workspace to improve development efficiency.
AI Context Enhancement - By providing Wiki as knowledge base together with code to AI tools, significantly improves AI's understanding of project context.
Information Security and Isolation - Wiki content is managed independently from the main code repository, maintaining document accessibility while enabling isolation protection for sensitive information.
Features
- 🌍 Supports both GitHub and GitLab (including enterprise/self-hosted instances)
- 📁 Automatic detection of project repository and Wiki URL
- 📝 Clones Wiki as a local
.wiki directory at your project root
- ⬇️ One-click Pull: Sync remote Wiki to your local workspace
- ⬆️ One-click Push: Update remote Wiki from your local
.wiki changes
- 🔒 Seamless authentication: Automatically uses your project’s Git credentials (no extra login)
- 🧹 No repo pollution: Wiki changes are fully isolated and excluded from your main repo commits
- ⚡ Cross-platform: Works on Windows, macOS, and Linux
Installation
From VS Code Marketplace:
- Open Extensions panel (
Ctrl+Shift+X)
- Search for
Git WiKi Sync
- Click Install
Or install from VSIX file:
code --install-extension git-wiki-sync-x.y.z.vsix
Usage
Note: For GitHub repositories, ensure the Wiki feature is enabled and at least one Wiki page is created; otherwise, synchronization will not work correctly.
Open your project root folder in VS Code (must be a GitHub or GitLab repository).
The extension will:
Automatically detect your remote
Clone the corresponding Wiki as a .wiki folder at your project root (if not already present)
Add .wiki/ to your .gitignore to avoid polluting your main repo
- Wiki commands are available in the Command Palette (Ctrl+Shift+P):
Git WiKi Sync: Pull Wiki – Pull latest changes from the remote Wiki
Git WiKi Sync: Push Wiki – Push your local Wiki changes to the remote
Git WiKi Sync: Open Wiki in Explorer – Open the .wiki folder directly
- Edit Markdown files in .wiki just like any project file.
When ready, use “Push” to update the remote Wiki!
FAQ
Does this extension support self-hosted GitHub/GitLab?
Yes! Any repository URL ending with .git will work; .wiki.git is inferred automatically.
Do I need to log in separately?
No. The extension uses your project’s Git credentials. If you can clone/push the main repo, Wiki sync will “just work”.
What if the Wiki repo doesn’t exist?
The extension will prompt you. Please enable the Wiki on your remote project first.
Are my Wiki changes part of the main repo?
No. All Wiki operations are fully isolated; .wiki is automatically added to .gitignore.
License
This project is licensed under the Apache 2.0 License. See the LICENSE file for details.
Acknowledgements
