Wiki Reader
A lightweight, Obsidian-style wiki reader for Visual Studio Code. Open any folder of Markdown files and navigate them as a clean, readable wiki — with wiki-links, local image rendering, full-text search, and a dark reading pane that stays out of your way.
Features
Rendered Markdown reading pane
Opens .md files in a styled reading view instead of raw source. Tables, code blocks, blockquotes, and headings all render properly.
Wiki-link navigation
Click any [[Page Name]] or [[Page Name|Display Text]] link to jump straight to that page. Links resolve relative to the current file, then the wiki root, then by recursive search — so reorganising folders doesn't break navigation.
Obsidian image embeds
Both ![[image.png]] (Obsidian) and  (standard Markdown) render inline. Images are resolved with the same three-tier lookup: next to the file → wiki root → anywhere under the wiki root.
All your .md files are listed in the Wiki Reader panel in the Activity Bar, sorted folders-first. Click any entry to open it. The tree refreshes automatically when files are added or removed.
Full-text search
Press the search icon in the Pages panel (or run Search Wiki from the Command Palette) to open a fuzzy search across all pages. Results show the file path and a preview of the first matching line.
Navigation history
Back and forward buttons in the reading toolbar let you retrace your steps, just like a browser.
Edit shortcut
The pencil button in the toolbar opens the current page in the VS Code text editor so you can switch to editing without hunting for the file.
Getting Started
Install from the Marketplace
Search for Wiki Reader in the VS Code Extensions panel (Ctrl+Shift+X) and click Install.
Open your wiki
- Open your wiki folder in VS Code (
File → Open Folder).
- Click the Wiki Reader icon in the Activity Bar (left sidebar).
- Your Markdown files appear in the Pages tree — click any page to open it.
If you want to use a subfolder as the wiki root rather than the whole workspace, run Set Wiki Root Folder from the Command Palette (Ctrl+Shift+P).
Configuration
| Setting |
Default |
Description |
wikiReader.wikiRoot |
"" |
Absolute path to the wiki root folder. Leave empty to use the first workspace folder. |
Supported Markdown
| Syntax |
Rendered as |
[[Page]] |
Wiki navigation link |
[[Page\|Label]] |
Wiki link with custom label |
![[image.png]] |
Inline image (Obsidian embed) |
 |
Inline image (standard Markdown) |
```code``` |
Syntax-highlighted code block |
> quote |
Styled blockquote |
\| table \| |
Full-width table |
**bold**, _italic_ |
Inline formatting |
--- |
Horizontal rule |
Known Limitations
- Mermaid diagrams and LaTeX math are not yet rendered.
- YAML frontmatter is displayed as a table rather than being hidden.
- Obsidian callout blocks (
> [!NOTE]) render as plain blockquotes.
- Scroll position is not restored when navigating back.
Requirements
- Visual Studio Code
1.85.0 or later.
- No other dependencies — everything is bundled.
Contributing
Bug reports and feature requests are welcome on GitHub Issues.
To build locally:
git clone https://github.com/hashan-jay_momentiv/wiki-reader-vs-ext.git
cd wiki-reader-vs-ext
npm install
npm run compile
# Press F5 in VS Code to launch the Extension Development Host
License
MIT © Hashan Jay
