Skip to content

v0.1.0

Choose a tag to compare

View all tags
@github-actions github-actions released this 14 Apr 19:30
· 1 commit to main since this release
v0.1.0
55b3db5

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

Assets 3
Loading