MD-Indexer

A lightweight Markdown documentation browser with a visual UI and optional write APIs. It scans one or more root folders, adds simple browsing tools (list/tree/recent/pinned), and lets you preview files with heading search.

Features

• List / Tree / Recent / Pinned views
• Tag & category filters
• Heading search
• File preview with paging
• Optional create/update/delete API

Quick Start (Docker)

docker run -p 3000:3000 \
  -e ROOT_DIR=/docs \
  -v /path/to/your/docs:/docs:ro \
  md-indexer

Quick Start (Node)

npm install
PORT=3000 ROOT_DIR=/path/to/docs node server.js

Configuration

Environment variables:

• PORT (default: 3000)
• BASE_PATH (default: /md-index)
• ROOT_DIR (default: current working dir)
• MD_INDEX_ROOTS (optional) comma-separated list of roots (e.g. /opt,/home/mb)
• MD_INDEX_ROOT_BASE (optional) base path used for relative paths when multiple roots (e.g. /)
• MD_WRITE_ROOT (optional) root for write operations (defaults to ROOT_DIR)

API

• GET /md-index/api/list (supports q, tag, category, recent=1)
• GET /md-index/api/view?path=...
• GET /md-index/api/headings?path=...&q=...
• GET /md-index/api/export?tag=...&category=...
• POST /md-index/api/create
• POST /md-index/api/update
• POST /md-index/api/delete

Security

The write endpoints modify files. If you don’t need them, protect the service behind auth or remove the routes.

License

MIT