Obsimini
Lightweight wiki navigation for Markdown knowledge bases in VS Code. Turns a
folder of interlinked .md files into something you can actually browse:
clickable [[wiki links]], hover previews, a backlinks panel, source-reference
jumps, and status-tag highlighting — with no external services and no lock-in.
Built for repos that use [[...]] links between notes, meeting summaries,
decision logs, and reference docs.
Features
📖 Wiki View (reading mode)
Run Obsimini: Open Wiki View (or click the 📖 button in a Markdown editor's
title bar) to open a self-contained reading tab in the current editor group.
Clicking a [[link]] navigates within the tab — with Back / Forward
buttons — so you can browse your wiki like a mini website, independent of VS
Code's preview settings. Source references open the cited file in an editor, and
status labels are color-badged.
This is the most convenient way to read and navigate; the editor features below
are for writing and cross-referencing.
🔗 Clickable [[wiki links]]
[[topics/motoko-overview]] and [[page|alias]] become clickable in both the
editor and the built-in Markdown preview (Ctrl/Cmd+Shift+V). Links resolve
two ways so mixed conventions keep working:
- verbatim path under your wiki root —
[[topics/page]] → topics/page.md
- otherwise by unique file name —
[[page]] → the one page.md in the tree
Unresolved links show in red in the preview so you can spot broken references.
Tip — where preview links open: clicking a [[link]] in the preview
follows VS Code's own setting markdown.preview.openMarkdownLinks. The default
"inPreview" navigates within the preview pane (great for browsing); set it to
"inEditor" if you'd rather each click open a real editor tab.
👁 Hover previews
Hover a [[link]] to see the top of the target page (YAML frontmatter is
skipped). Configure how many lines with obsimini.hover.previewLines.
↩ Backlinks panel
An Explorer view lists every page that links to the file you're viewing, with
the exact line — click to jump. Great for seeing how a topic is referenced.
📎 Source-reference jumps
If your notes cite sources like [來源: meeting-2026-07-09 @ 05:23] or
[source: report.pdf], Obsimini makes them clickable and opens the matching
file from a folder you choose (e.g. a meeting_transcript/ directory). Fully
regex-configurable — see obsimini.sourceLink.*.
🏷 Status-tag highlighting
Labels such as ✅ decided, 🟡 pending, 🔄 evolving, ❌ dropped get a
colored badge so decision tables are scannable. Labels and colors are
configurable via obsimini.statusBadges (set to {} to disable).
Settings
| Setting |
Default |
Description |
obsimini.wikiRoot |
"" (workspace root) |
Folder containing your wiki; links resolve against it. |
obsimini.linkExtension |
.md |
Extension appended to link targets. |
obsimini.hover.previewLines |
30 |
Lines shown in hover previews. |
obsimini.statusBadges |
see below |
Label → hex-color map for highlighting. |
obsimini.sourceLink.enabled |
true |
Enable source-reference jumps. |
obsimini.sourceLink.pattern |
[來源: … @ …] |
Regex; capture group 1 = target file name. |
obsimini.sourceLink.targetFolders |
["meeting_transcript", "."] |
Folders searched for source files. |
Example project settings (.vscode/settings.json):
{
"obsimini.wikiRoot": "wiki",
"obsimini.sourceLink.targetFolders": ["meeting_transcript"]
}
Default status badges:
{
"✅ decided": "#3fb950",
"🟡 pending": "#d29922",
"🔄 evolving": "#58a6ff",
"❌ dropped": "#f85149"
}
Roadmap
- Graph view — an interactive node-link map of your wiki (planned for a
future release).
Development
npm install
npm run watch # or: npm run build
# press F5 in VS Code to launch an Extension Development Host
Package a .vsix: npm run package.
License
MIT
