An open-source visual Markdown editor for VS Code. Write in a rendered view, switch to source when needed, and work with tables, code, equations, and diagrams in the same document.
Download a release · Documentation · Changelog · Report an issue
Built on Any Markdown by raggbal and contributors, which provides the visual editor and much of its existing functionality under MIT. BinaryOutlook independently maintains Binary Markdown's changes, releases, and support. See Acknowledgments for provenance.
Version 0.5.1 is being prepared as a rapid update replacing the previous version's unstable table toolbar with a more stable, compact toolbar. It retains the Visual/Source/Split views, command search, source-based Find and Replace, and per-block code wrapping introduced in 0.5.0. Read the 0.5.1 notes and apology and changelog. Available packages, exact source revisions and checksums are listed on GitHub Releases; release preparation does not establish publication.
Use local desktop VS Code 1.85.0 or later. Validation targets Windows x86-64, macOS ARM64, and Ubuntu x86-64; each release identifies the environments actually tested. Standalone Electron installers and other editors require separate validation.
- Download the
.vsixand its SHA-256 checksum from GitHub Releases, or build from source. Follow the checksum instructions before installing. - In VS Code, open Extensions, choose … → Install from VSIX…, select the package, and reload if prompted.
- Open a Markdown file and choose Reopen Editor With… → Binary Markdown.
For unreleased branch or PR work, download an automated development VSIX. Check the run's validation status and retain the checksum and build-information sidecars. These temporary testing packages do not publish a Marketplace update.
The extension ID is BinaryOutlook.binary-markdown. Installation leaves your default Markdown editor unchanged; use Configure Default Editor… if you want Binary Markdown to open every Markdown file. Updating this extension retains its identity and settings. For older Any Markdown or test-build IDs, follow the migration guide.
- Visual, Source, and Split views: semantic paragraphs and lists, preserved source for unchanged blocks, links, images, blockquotes, an Outline/Document rail, and an editable Markdown pane beside a read-only live preview.
- Formatting and tables: Full or Simple toolbars, a permanent three-dot search across formatting and insertion commands, a
>>/<<toolbar toggle with optional contextual tools, and the retained Insert workspace and Action Palette, HTML-backed underline, compact table controls with clickable row/column gutters and distinct text selection, horizontal scrolling for wide tables, and aligned or compact source formatting for edited tables. - Code and equations: syntax highlighting, searchable language selection, labeled code controls for copying and soft wrapping, a visible wrap notice, editable KaTeX source, and Mermaid diagrams. See code block features.
- A configurable writing space: themes, seven interface languages, full or capped column width, column alignment, and optional width guides.
- Find and Replace: source-context results, selected replacements, and case, whole-word, or regular-expression matching with a shared undo history.
- Document structure: protected YAML front matter and a generated table of contents refreshed on save or on request.
- Experimental export: local HTML, PDF, Word, and EPUB conversion, with PDF/DOCX code labels, optional line counts, and optional numbering.
These features describe the current source. The changelog groups changes by version; GitHub Releases establishes publication. In 0.4.0, unset toolbar preferences use Full mode and unset export-label positions use top-left; explicit saved choices remain honored. Width still starts at a centered 860 px cap, and line counts and numbering remain off by default.
Open Settings (Cmd+, on macOS or Ctrl+, on Windows/Linux) and search for Binary Markdown. The editor settings reference lists defaults and explains outline state, table controls and source formatting, layout, and equation-source options. The language guide distinguishes editor language from VS Code's settings language.
With the editor focused:
| Action | macOS | Windows/Linux |
|---|---|---|
| Open action palette | Cmd+/ |
Ctrl+/ |
| Toggle source mode | Cmd+. |
Ctrl+. |
| Open as text | Cmd+Shift+. |
Ctrl+Shift+. |
Search for Binary Markdown in the Command Palette for editing, export, and Copy Build Information commands. The editor guide covers keyboard operations, tables, code, equations, and images.
Save a named Markdown file in a trusted local workspace, then open the sharing-arrow export button (accessible name Export). In a narrow pane, find it under More toolbar actions. Export shows progress, supports cancellation, and saves beside the source without overwriting existing files.
| Format | Required tool |
|---|---|
| HTML | None beyond the extension |
| Chrome, Chromium, or Microsoft Edge | |
| Word (.docx), EPUB | Pandoc |
Tools are user-installed. Follow export help for setup, executable paths, output naming, and format-specific settings, or start with the HTML export tutorial.
Export is unavailable in Remote-SSH and other remote hosts, browser VS Code, and the standalone desktop app. DOCX numbering remains experimental: Enter on an empty numbered line can end numbering and change formatting; copying and reading order vary by reader. PDF gutters can appear in copied text. The reader checkpoint records tested versions and remaining checks. Long custom DOCX language labels can extend outside their tab in Word. Review the 0.5.1 known limitations, especially external writes that can still replace unsaved editor content, when working on important documents.
Source builds, focused fixes, translations, accessibility work, and reproducible bug reports are welcome. Start with the build guide, contributor workflow, and validation guide. The editor architecture maps the modules and their state ownership. Use Copy Build Information when reporting a problem, with a small non-private example and clear reproduction steps.
The documentation index organizes current guides. Release notes describe individual versions; reports preserve observations for specific revisions. Development builds and older commits are covered by the support policy.
Free (cost): official releases and all editor features are available at no charge. Free (freedom): you may run, study, modify, and redistribute the software under the applicable licenses. This commitment draws on Richard Stallman's, the GNU Project's, and the Free Software Foundation's free software philosophy. See the licensing guide for the four freedoms and redistribution obligations.
Binary Markdown uses AGPL-3.0-or-later. Earlier MIT grants, the upstream MIT notice, and third-party terms remain intact; see NOTICE. MIT-licensed starting points include Binary Markdown v0.1.0 and Any Markdown. The repository transition guide preserves links to the original fork, reviews, and releases.