md-sleek

Serve markdown files as beautiful HTML pages with live reload and Mermaid diagram support.

Zero config. Just point it at a directory.

Features

• GitHub-flavored styling with light/dark mode (follows system preference)
• Syntax highlighting via highlight.js
• Mermaid diagrams rendered as SVG via beautiful-mermaid
• Live reload on file changes
• Directory listing sorted by last modified
• No client-side JavaScript frameworks — pure HTML/CSS

Install

npm install -g md-sleek

Usage

# Serve current directory
md-sleek

# Serve a specific directory
md-sleek ./docs

# Custom port
md-sleek -p 8080

# Open browser on start
md-sleek -o

# Disable live reload
md-sleek --no-reload

# Combine options
md-sleek ./docs -p 4000 -o

Open http://localhost:3000 to see the directory listing, click any .md file to view it.

Programmatic API

import { startServer, renderMarkdown } from 'md-sleek';

// Start a server
const server = startServer({
  dir: './docs',
  port: 3000,
  open: false,
  reload: true,
});

// Or just render markdown to HTML
const html = await renderMarkdown('# Hello\n\nWorld', {
  title: 'Hello',
  liveReload: false,
});

CLI Options

| Option | Description | Default | |---|---|---| | [directory] | Path to markdown directory | . | | -p, --port <num> | Port number | 3000 | | -o, --open | Open browser on start | false | | --no-reload | Disable live reload | false | | -h, --help | Show help | | | -v, --version | Show version | |

Requirements

Node.js >= 18.17.0

License

MIT