MarkdownViewer

Markdown Viewer for VS Code Markdown

Preview Markdown without opening VS Code — check output in the browser.

235 chars

A small typed HTTP client.

Usage

import { Client } from './client';

const c = new Client({ baseUrl: 'https://api.example.com' });
await c.get('/users');

Scripts

  • npm run build — compile
  • npm test — run tests

What is Markdown Viewer for VS Code?

VS Code has a built-in Markdown preview, but it is tied to the editor and the machine the project is open on. When you want to check a Markdown file quickly — on a different computer, from a shared doc, or before opening a heavy project — a browser viewer does the same job. This viewer uses GitHub-flavoured Markdown, so the output matches what VS Code's preview and a repository page will show.

Common Uses for Markdown Viewer for VS Code

  • Checking a README or docs file without launching VS Code
  • Previewing Markdown on a machine that does not have the project open
  • Reviewing a Markdown change before committing it
  • Rendering Markdown copied out of a code review or chat

Why Markdown is the default for developer docs

Developers read Markdown everywhere: repositories, pull requests, wikis, issue templates, changelogs. It has won that place because it is plain text — readable in a diff, greppable, and version-controlled like code. A browser preview fits that workflow by making it trivial to check the rendered result at any point, without switching context into an editor.

Preview parity matters

The value of a preview is only as high as its fidelity. If a viewer used a different Markdown dialect than your repository, it would show a table where GitHub shows broken text, and vice versa. Because this viewer and VS Code both follow GitHub-flavoured Markdown, what you check in the browser is what you see after the commit.

Frequently Asked Questions

Does this match the VS Code preview?
The structure does. Both use GitHub-flavoured Markdown, so headings, tables, task lists, code fences and links render the same way. Colours and fonts differ from VS Code's theme, but the layout and content match.
Why not just use VS Code's built-in preview?
VS Code's preview requires the file to be open in the editor and the project to be on that machine. A browser viewer is quicker for a one-off check — open a tab, paste, read, close — and needs no project setup.
Does it support fenced code blocks with languages?
Yes. Triple-backtick fences with a language name render as code blocks, preserving the language hint. Syntax highlighting depends on the renderer; this viewer shows the block formatted, which is enough for reviewing structure.
Is anything uploaded?
No. Rendering is local to your browser, so internal documentation and unreleased project files stay on your device.

More Markdown Tools