Skip to content

kroe761/markdown-viewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 

Repository files navigation

markdown-viewer

A tiny zero-dependency Node script that serves a directory of markdown files in the browser, renders them, and live-reloads when files change on disk.

Built for the workflow where you have Claude Code (or any tool) editing markdown in a terminal on one side of the screen and want a live-rendered preview on the other.

Features

  • Single file, no npm install, no dependencies
  • Sidebar lists .md files and subdirectories — click to navigate
  • Slideout sidebar so the rendered content gets the full window
  • Auto-refresh: the page re-renders as soon as the file changes on disk (via fs.watch + Server-Sent Events)
  • Manual refresh button as a fallback

Requirements

  • Node.js 18+ (uses built-ins only)

Usage

node server.js /path/to/your/markdown/dir

Then open http://localhost:3000.

Omit the path to serve the current directory. Override the port with PORT=4000 node server.js ….

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors