✓ Verified 💻 Development ✓ Enhanced Data

Markdown Viewer

Live markdown viewer for AI pair-editing.

Rating
4.3 (148 reviews)
Downloads
3,442 downloads
Version
1.0.0

Overview

Live markdown viewer for AI pair-editing.

Key Features

1

SSE-powered live reload (works in Safari, Chrome, Firefox)

2

Multi-file support (each tab watches its own file)

3

GitHub Flavored Markdown (tables, task lists, strikethrough)

4

Syntax highlighting (180+ languages)

5

Dark mode

6

Table of contents

7

Mermaid diagrams

8

KaTeX math equations

Complete Documentation

View Source →

Live Markdown Viewer

Live markdown viewer for AI pair-editing. When you collaborate, the updates render instantly. Works with any AI agent and web browser.

GitHub: wipcomputer/wip-markdown-viewer npm: @wipcomputer/markdown-viewer

Install

bash
npm install -g @wipcomputer/markdown-viewer

This installs the mdview command globally. Zero runtime dependencies. Pure Node.js.

Quick start

Start the server (binds to 127.0.0.1 only, never exposed to the network):

bash
curl -s http://127.0.0.1:3000/ > /dev/null 2>&1 || mdview &

Open a file in your default browser:

bash
# macOS
open "http://127.0.0.1:3000/view?path=/absolute/path/to/file.md"

# Linux
xdg-open "http://127.0.0.1:3000/view?path=/absolute/path/to/file.md"

# Windows
start "http://127.0.0.1:3000/view?path=/absolute/path/to/file.md"

How it works

  • Tell your AI coding tool to install @wipcomputer/markdown-viewer globally
  • Tell your AI to open a .md file in md view
  • AI opens the file in your default browser
  • Every save re-renders the page instantly. No refresh needed.
Open multiple tabs to work on multiple documents at once.

Security

  • Server binds to 127.0.0.1 only. It is not accessible from other machines.
  • The /view?path= parameter reads files from your local filesystem. Use --root to restrict access to a specific directory tree. Recommended for shared environments.
  • Zero npm dependencies. No supply chain risk beyond Node.js itself.

Features

  • SSE-powered live reload (works in Safari, Chrome, Firefox)
  • Multi-file support (each tab watches its own file)
  • GitHub Flavored Markdown (tables, task lists, strikethrough)
  • Syntax highlighting (180+ languages)
  • Dark mode
  • Table of contents
  • Mermaid diagrams
  • KaTeX math equations

Troubleshooting

Page shows the index instead of my file: The server was started with --root restricting access. Restart without --root.

Safari stalls or shows blank page: Hard refresh (Cmd+Shift+R) or restart the server. Safari caches SSE connections aggressively.

macOS open drops the query string: Use AppleScript instead:

bash
osascript -e 'tell application "Safari" to open location "http://127.0.0.1:3000/view?path=/your/file.md"'

Notes

  • Server runs at http://127.0.0.1:3000 by default. Use mdview --port 8080 to change.
  • The server does not survive reboots. The curl check in quick start restarts it if needed.
  • Do NOT start the server with a file path argument. Always start bare (mdview). Starting with a path locks the server to that directory.
  • Drag and drop any .md file onto the homepage to view it.
  • Zero external requests. All dependencies bundled locally.

Installation

Terminal bash

openclaw install markdown-viewer
    
Copied!

💻Code Examples

npm install -g @wipcomputer/markdown-viewer

npm-install--g-wipcomputermarkdown-viewer.txt
This installs the `mdview` command globally. Zero runtime dependencies. Pure Node.js.

## Quick start

Start the server (binds to 127.0.0.1 only, never exposed to the network):

start "http://127.0.0.1:3000/view?path=/absolute/path/to/file.md"

start-http1270013000viewpathabsolutepathtofilemd.txt
## How it works

1. Tell your AI coding tool to install `@wipcomputer/markdown-viewer` globally
2. Tell your AI to open a .md file in md view
3. AI opens the file in your default browser
4. Every save re-renders the page instantly. No refresh needed.

Open multiple tabs to work on multiple documents at once.

## Security

- Server binds to `127.0.0.1` only. It is not accessible from other machines.
- The `/view?path=` parameter reads files from your local filesystem. Use `--root <dir>` to restrict access to a specific directory tree. Recommended for shared environments.
- Zero npm dependencies. No supply chain risk beyond Node.js itself.

## Features

- SSE-powered live reload (works in Safari, Chrome, Firefox)
- Multi-file support (each tab watches its own file)
- GitHub Flavored Markdown (tables, task lists, strikethrough)
- Syntax highlighting (180+ languages)
- Dark mode
- Table of contents
- Mermaid diagrams
- KaTeX math equations

## Troubleshooting

**Page shows the index instead of my file:** The server was started with `--root` restricting access. Restart without `--root`.

**Safari stalls or shows blank page:** Hard refresh (Cmd+Shift+R) or restart the server. Safari caches SSE connections aggressively.

**macOS `open` drops the query string:** Use AppleScript instead:
example.sh
# macOS
open "http://127.0.0.1:3000/view?path=/absolute/path/to/file.md"

# Linux
xdg-open "http://127.0.0.1:3000/view?path=/absolute/path/to/file.md"

# Windows
start "http://127.0.0.1:3000/view?path=/absolute/path/to/file.md"

Tags

#web_and-frontend-development

Quick Info

Category Development
Model Claude 3.5
Complexity One-Click
Author parkertoddbrooks
Last Updated 3/10/2026
🚀
Optimized for
Claude 3.5
🧠

Ready to Install?

Get started with this skill in seconds

openclaw install markdown-viewer