Mk markdown reader

Skill ngocsangyem/MeowKit/packages/mewkit/src/migrate/modules/codex/root/.agents/skills/mk-markdown-reader

Serve a markdown file/directory as a calm, book-like reader via a local HTTP server (127.0.0.1 only); good for long-form docs like RFCs and plans. Supports Mermaid, dark/light mode, and a nav sidebar.From its SKILL.md

Install

npx -y skills add ngocsangyem/MeowKit --skill mk-markdown-reader

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

15 stars15 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

2.4 KB, 521 tokens by cl100k_base, as published. Nobody here has run it

mk:markdown-reader

Local HTTP server rendering markdown files with a calm, book-like reading experience.

Note: mk:brainstorming --html and mk:plan-creator --html produce self-contained HTML files that open directly in the browser — they do not use or need this server.

Installation (Required Before First Use)

This skill requires npm dependencies. Install once from the project root:

cd .agents/skills/markdown-reader
npm install

Dependencies: marked, highlight.js, gray-matter

Without installation you will get Error 500: Error rendering markdown.

Usage

# View a markdown file (opens browser automatically)
node .agents/skills/markdown-reader/scripts/server.cjs \
  --file ./tasks/plans/my-plan/plan.md

# Browse a directory
node .agents/skills/markdown-reader/scripts/server.cjs \
  --dir ./tasks/plans

# Background mode (foreground process for Codex task runners)
node .agents/skills/markdown-reader/scripts/server.cjs \
  --file ./README.md \
  --foreground

# Stop all running instances
node .agents/skills/markdown-reader/scripts/server.cjs --stop

The server binds to 127.0.0.1 (localhost) only. Served files are not reachable from other devices on the network — this is intentional.

Lifecycle

Start with --file or --dir; use --foreground when the host needs to keep the process attached. The default port is 3456 and increments through 3500 if busy. End the lifecycle with --stop; never leave a reader process running after the task.

Need	Route
CLI flags, routes, persistent state	references/reader-operations.md
Reader features, plan navigation, shortcuts, Mermaid	references/reader-experience.md
Architecture and troubleshooting	references/reader-operations.md

The server binds only to 127.0.0.1. It validates every file against its allowed directories; traversal attempts return 403. Referenced images must be relative to the source markdown file.

Self-contained HTML from mk:brainstorming --html or mk:plan-creator --html opens directly and does not need this server.

What ships with it: 24 files

136.7 KB alongside SKILL.md, 8 of them executable

assets/

references/

reader-experience.md625 B
reader-operations.md1.1 KB

scripts/

package.json352 B