Obsidian GitLab Wiki Integration
pendingby GrzeskoByte
Sync and manage GitLab Wiki repositories directly from Obsidian.
Obsidian GitLab Wiki Integration
Sync and manage GitLab wiki repositories directly inside Obsidian.
This plugin helps you keep documentation in GitLab Wiki and edit it from your vault, with file status indicators and one-click repository sync.
Key Features
- Connect one or more GitLab repositories from plugin settings.
- Clone each repo wiki into
Gitlab_Repositories/<repo-name>inside your vault. - Show file change status in the File Explorer (
M,C,D). - Add a quick sync action for repositories in the explorer.
- Pull when clean, or add/commit/push when changes are present.
Installation
Community Plugins (after approval)
- Open Settings → Community plugins in Obsidian.
- Disable Safe mode (if required).
- Search for Obsidian GitLab Wiki Integration.
- Install and enable the plugin.
Manual Installation
- Download
main.js,manifest.json, andstyles.cssfrom the latest GitHub release. - Create:
.obsidian/plugins/obsidian-gitlab-wiki-integration/in your vault. - Copy the three files into that folder.
- Reload Obsidian and enable the plugin in Community plugins.
Usage
- Open plugin settings.
- Add one or more GitLab repository URLs.
- Use the sync button next to a repository in the file explorer.
- Edit markdown files in
Gitlab_Repositories/<repo-name>/. - Sync again to push your changes.
Configuration
- Gitlab Repository URL: Add repository URLs one by one.
- Private repositories: Ensure the URL includes your username and personal access token (or password) in this format:
https://<username>:<token-or-password>@gitlab.com/repo.git. - Add repository: Create additional repository entries.
- Remove repository: Delete an existing configured repository.
- Sync repository: Clone/update the selected repo wiki.
Screenshots
Placeholder: add screenshots for settings UI, file status badges, and sync button in explorer.
Development
- Install dependencies:
npm install - Build once:
npm run build - Watch mode:
npm run dev
Future Development
- Add custom git actions per repository (stage selected files, commit with custom message, pull/rebase, push, stash).
- Add quick actions in the explorer context menu for common workflows (pull, commit+push, discard file changes).
- Reflect actual git tree state in Obsidian by parsing full
git status --porcelainoutput for tracked, untracked, renamed, and deleted paths. - Include deleted files in the tree view as pending deletions until sync, with clear visual status and optional restore action.
- Improve repository state refresh to avoid stale indicators after rename/delete operations.
- Add support for GitHub Wiki repositories.
For plugin developers
Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.