Skip to content

Releases: mardoc-app/mardoc-vscode

v0.1.4

17 Apr 01:25
41088d5

Choose a tag to compare

What's new

Local images render in embed mode

Markdown opened via Edit with MarDoc now renders relative image references (![arch](docs/images/arch.png), ./foo.png, ../assets/logo.png) from disk. The extension reads the bytes via a new file:read-image postMessage bridge and hands back a base64 data URI. Previously these showed as broken images because the browser has no filesystem access.

Multi-root workspace correctness

Fixes a class of bugs triggered by having multiple repos open in one VS Code window. The extension was reading owner/repo, the relative file path, and image paths from workspaceFolders[0] — which is almost always the wrong repo. It now resolves each of those against the git root of the file you actually opened:

  1. The workspace folder VS Code says contains the file
  2. Or the nearest .git ancestor if the file sits outside all workspace folders
  3. Falling back to the first workspace folder only for the bare MarDoc: Open command (no file context)

Configurable app URL

New mardoc.appUrl setting. Default is https://mardoc.app. Point it at http://localhost:3000 to develop against a local npm run dev server without rebuilding the extension.


Install

Option A — download and install from the command line:

  1. Download mardoc-0.1.4.vsix from the Assets section below.
  2. Run:
    code --install-extension ~/Downloads/mardoc-0.1.4.vsix --force
    
  3. Reload the VS Code window (Cmd+Shift+PDeveloper: Reload Window).

Option B — install from VS Code UI:

  1. Download mardoc-0.1.4.vsix from the Assets section below.
  2. Open the Extensions view (Cmd+Shift+X).
  3. Click the ... menu in the Extensions panel header → Install from VSIX…
  4. Select the downloaded file.
  5. Reload the window.

To confirm the install, open the Extensions view and find MarDoc — it should show version 0.1.4.


Companion app release

This release expects the app-side bridge that ships on https://mardoc.app from mardoc-io.github.io#95. If you're pointing mardoc.appUrl at a custom URL, make sure that server is on a build that includes the file:read-image protocol and the __local__/ gate in rewriteImageUrls.

v0.1.0

14 Apr 19:30

Choose a tag to compare

MarDoc for VS Code — v0.1.0

First shippable release. All core interactions — open, edit, copy, close — now work reliably inside VS Code's webview.

What MarDoc does

Turns VS Code's flat markdown and HTML files into a rich WYSIWYG surface backed by mardoc.app. Right-click any .md, .mdx, .html, or .htm file → Edit with MarDoc to open it in a rendered, clickable, commentable panel next to your code. Git operations (commit, branch, push) stay in VS Code; MarDoc handles rendering, editing, and PR review.

Install

Download mardoc-0.1.0.vsix below and run:

code --install-extension mardoc-0.1.0.vsix --force

Then reload the VS Code window (Cmd+Shift+P → "Developer: Reload Window").

What works in 0.1.0

  • "Edit with MarDoc" context menu for .md, .mdx, .html, .htm
  • Rich markdown editing — headings, lists, tables, fenced code blocks with syntax highlighting, mermaid diagrams, GitHub alerts (> [!NOTE]), footnotes — all WYSIWYG via TipTap
  • HTML rendering with selection-to-comment in a sandboxed iframe
  • GitHub PR review from inside VS Code — rendered diffs, inline comments, approve / request changes / comment
  • Theme sync — the webview follows VS Code's active color theme (light ↔ dark)
  • GitHub auth auto-detection via vscode.authentication.getSession('github') — no separate token setup when VS Code is already signed in
  • Keyboard shortcuts inside the webview: Cmd+C, Cmd+V, Cmd+X, Cmd+Z, Cmd+Shift+Z, Cmd+A, and Cmd+W

Usage

Right-click a supported file in the Explorer → Edit with MarDoc. Or run MarDoc: Open from the command palette to launch the repo browser.

The extension auto-detects your workspace's GitHub remote and branch. When VS Code has GitHub auth configured, the token is passed through automatically so PRs load without extra setup.

Requirements

  • VS Code ^1.85.0
  • A workspace backed by a GitHub remote (optional — MarDoc also supports local markdown editing without a remote)

Known gaps

  • The extension doesn't yet publish to the VS Code Marketplace automatically on every tag — you can always grab the .vsix from the Releases page here.
  • Save-back is wired for markdown only; HTML files are view-only for now.
  • iPad / tablet form-factors are not specifically tested.

Full Changelog: v0.0.1...v0.1.0