Markdown to GitHub-Style HTML (VS Code Extension)

One-click export of Markdown to GitHub-style HTML (auto light/dark), plus a shareable ZIP that bundles linked Markdown pages and local assets for offline viewing.

Use cases

Share Markdown documentation with clients without sharing your entire repo.
Keep the familiar GitHub look and readability in a local browser.
Export a folder of docs as a single offline ZIP.

Quick start

Open a .md file in VS Code.
Click the export icon in the editor title bar:
Choose an export option:

Export options

Option	Output	Notes
Export to `.html`	Sibling `.html` next to the active `.md`	GitHub-style CSS (auto light/dark); preserves relative links and image paths
Export to ZIP (`.html + assets`)	Sibling `.zip` next to the active `.md`	Rewrites local Markdown links (`.md` → `.html`) and bundles linked pages + local assets
Export folder → ZIP (bulk)	`.zip` saved to a chosen location	Exports the active Markdown file’s parent folder (all `.md` files) and bundles local assets

Demos

Export current Markdown to HTML

Demo: export current Markdown to HTML

Export current Markdown to a shareable ZIP

Demo: export current Markdown to ZIP

Export a folder to a shareable ZIP (bulk export)

Demo: export folder to ZIP

Commands

Editor toolbar (Markdown files): click the export icon to open the export picker.
Command Palette: Export Markdown, Export to GitHub-Style HTML, Export to GitHub-Style HTML (ZIP + Assets)
Command IDs: mdExport.export, mdExport.exportGithubHtml, mdExport.exportGithubHtmlZip

Documentation

Technical docs (architecture, development, release): docs/README.md

Privacy / network

This extension runs locally and does not make network requests at runtime.
If your Markdown contains remote links or images, the exported HTML may still reference those URLs, and a browser may fetch them when opened.

Security note

Exported HTML may include raw HTML from your Markdown (the renderer allows embedded HTML).
Only export and open HTML generated from Markdown you trust.

Limitations

Only local files are bundled into ZIPs. Remote assets are left as-is.
ZIP export only includes Markdown files reachable via local links from the entry file(s).
Folder ZIP exports the active Markdown file’s parent folder (not an arbitrary selection).

Requirements

VS Code ^1.80.0

Development

npm install
npm run build
npm run verify
Press F5 (Run Extension) in VS Code to launch an Extension Development Host.
More details: docs/development/dev-setup.md

Scripts

See docs/development/scripts-and-workflows.md for the full list.
Common scripts: npm run build, npm test, npm run verify, npm run package

Licenses

See LICENSE.
Bundled asset notices are documented in THIRD_PARTY_NOTICES.md.

Markdown to GitHub-Style HTML

Guillermo Polito