docMD

View markdown documentation as a tree. Scan any project, browse .md files in a formatted web viewer with a collapsible sidebar, drag-to-resize, and light/dark theme.

Works in any Node.js project—install globally or as a dev dependency, then run to open a local docs viewer.

Install

# Use with npx (no install)
npx @unseen-media/docmd

# Or install globally
npm install -g @unseen-media/docmd

# Or as a dev dependency
npm install -D @unseen-media/docmd

Usage

# View docs in current directory
docMD

# View docs in a specific folder
docMD ./docs

# Custom port (default: 3847)
docMD -p 3000
docMD --port 3000

Then open http://localhost:3847 (or your chosen port) in your browser.

Programmatic API

const docMD = require('@unseen-media/docmd');

// Get tree structure of all .md files
const tree = docMD.getDocTree('./docs');
// => [{ name: 'readme.md', path: 'readme.md', isFile: true }, ...]

// Get flat list of paths
const paths = docMD.getDocPaths('./docs');
// => ['readme.md', 'guides/getting-started.md', ...]

Features

• Tree view of all markdown files (nested folders supported)
• Formatted markdown rendering
• Edit mode with CodeMirror 6 – syntax highlighting, line numbers, save changes
• Collapsible sidebar with drag-to-resize
• Light/dark theme toggle (persisted)
• Saves sidebar width and collapsed state

What gets scanned

• Recursively finds all .md files
• Ignores: node_modules, .git, dist, build, .next, __pycache__, .cache, coverage, .vscode, .idea
• Shows folders only if they contain markdown (directly or in subfolders)

License

• MIT · © Unseen Media