Skip to content
cccskills
FreePublished on GitHub

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.

The English summary is being prepared. Showing the original description.

See how to install

Files included (25)

  • SKILL.md2.4 KB
  • assets/directory-browser.css2.9 KB
  • assets/favicon.ico15.0 KB
  • assets/novel-theme.css612 B
  • assets/reader.js23.9 KB
  • assets/styles/novel-theme-base.css1013 B
  • assets/styles/novel-theme-components.css3.8 KB
  • assets/styles/novel-theme-content.css2.9 KB
  • assets/styles/novel-theme-header.css3.9 KB
  • assets/styles/novel-theme-mermaid.css3.1 KB
  • assets/styles/novel-theme-overlays.css3.6 KB
  • assets/styles/novel-theme-responsive.css4.5 KB
  • assets/styles/novel-theme-sidebar.css6.2 KB
  • assets/styles/novel-theme-variables.css1.4 KB
  • assets/template.html6.0 KB
  • package.json352 B
  • references/reader-experience.md625 B
  • references/reader-operations.md1.1 KB
  • scripts/lib/http-server.cjs11.4 KB
  • scripts/lib/markdown-renderer.cjs9.7 KB
  • scripts/lib/plan-navigator.cjs10.1 KB
  • scripts/lib/plan-table-parser.cjs9.9 KB
  • scripts/lib/port-finder.cjs1.2 KB
  • scripts/lib/process-mgr.cjs3.7 KB
  • scripts/server.cjs9.6 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

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.

NeedRoute
CLI flags, routes, persistent statereferences/reader-operations.md
Reader features, plan navigation, shortcuts, Mermaidreferences/reader-experience.md
Architecture and troubleshootingreferences/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.

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Use this skill to generate well-branded interfaces and assets for MeowKit (AI Agent Toolkit for Claude Code), either for production or throwaway prototypes/mocks/etc. Contains essential design guidelines, colors, type, fonts, assets, and UI kit components for prototyping.

The English summary is being prepared. Showing the original description.

ngocsangyem/MeowKit15Updated Jul 28, 2026

Turn a raw idea into ONE honest recommendation: interview one question at a time until confirmed, then give a verdict with trade-offs and a checklist. Not for options or debate.

The English summary is being prepared. Showing the original description.

ngocsangyem/MeowKit15Updated Jul 28, 2026

Browser automation CLI for agents: navigate, click/fill, screenshot, extract data, test apps, Electron/Slack, cloud browsers. NOT for the user's real Chrome profile/cookies (mk:chrome-profile).

The English summary is being prepared. Showing the original description.

ngocsangyem/MeowKit15Updated Jul 28, 2026

Detects the right agent and complexity tier at Phase 0 orient; runs first in every workflow. NOT for runtime agent routing inside a single skill.

The English summary is being prepared. Showing the original description.

ngocsangyem/MeowKit15Updated Jul 28, 2026

Angular v20+ patterns: components, signals, services, forms, routing, HTTP, testing, SSR. Auto-activates on .ts files in Angular projects (angular.json detected).

The English summary is being prepared. Showing the original description.

ngocsangyem/MeowKit15Updated Jul 28, 2026

Design and review durable REST, GraphQL, RPC, or event API contracts: shape, compatibility, pagination, error semantics. Discovers existing consumers first. Not implementation, schema, or release.

The English summary is being prepared. Showing the original description.

ngocsangyem/MeowKit15Updated Jul 28, 2026

See all skills by ngocsangyem

Report a problem with this skill