How do I install the Mk Markdown Reader skill?

Run npx skillmds@latest add ngocsangyem/mk-markdown-reader-2 in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Mk Markdown Reader safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Mk Markdown Reader?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Mk Markdown Reader free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Mk Markdown Reader?

ngocsangyem (@ngocsangyem) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Mk Markdown Reader by ngocsangyem — Agent Skill

Name: Mk Markdown Reader
Author: ngocsangyem

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.

ngocsangyem c401409 25 files · 139.1 KB Updated Sep 17, 2026

File contents

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.

---name: mk-markdown-reader-2description: 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.---# mk:markdown-readerLocal HTTP server rendering markdown files with a calm, book-like reading experience.**Note:** `mk:brainstorming --html` and `mk:plan-creator --html` produce self-containedHTML 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:```bashcd .agents/skills/markdown-readernpm install```**Dependencies:** `marked`, `highlight.js`, `gray-matter`Without installation you will get **Error 500: Error rendering markdown**.## Usage```bash# View a markdown file (opens browser automatically)node .agents/skills/markdown-reader/scripts/server.cjs \ --file ./tasks/plans/my-plan/plan.md# Browse a directorynode .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 instancesnode .agents/skills/markdown-reader/scripts/server.cjs --stop```The server binds to `127.0.0.1` (localhost) only. Served files are not reachable fromother devices on the network — this is intentional.## LifecycleStart with `--file` or `--dir`; use `--foreground` when the host needs to keep the processattached. 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](references/reader-operations.md) || Reader features, plan navigation, shortcuts, Mermaid | [references/reader-experience.md](references/reader-experience.md) || Architecture and troubleshooting | [references/reader-operations.md](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 directlyand does not need this server.

Frequently asked questions