markdown-novel-viewer

Render Markdown files and directories via an HTTP server.

Updated Dec 25, 2025
One-click install
npx skills add https://github.com/PhucMPham/threejs-christmas-tree --skill markdown-novel-viewer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdown-novel-viewer
Source: https://github.com/PhucMPham/threejs-christmas-tree/tree/main/.claude/skills/markdown-novel-viewer
Command: npx skills add https://github.com/PhucMPham/threejs-christmas-tree --skill markdown-novel-viewer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires marked, highlight.js, gray-matter, and includes scripts (resource) and assets (resource) components.

What problem does it solve?

This Skill provides a background HTTP server that renders Markdown files as a calm, book-like reading experience, plus directory browsing for easy access to related content.

Core Features & Use Cases

  • Markdown Rendering: Converts Markdown to clean HTML with syntax highlighting.
  • Directory Browsing: Browse content and navigate to files.
  • Remote Access: Serve content over HTTP for local or remote access.

Quick Start

To view a Markdown file: node .claude/skills/markdown-novel-viewer/scripts/server.cjs
--file ./plans/my-plan/plan.md
--open

To browse a directory: node .claude/skills/markdown-novel-viewer/scripts/server.cjs
--dir ./plans
--host 0.0.0.0
--open

Stop all servers: node .claude/skills/markdown-novel-viewer/scripts/server.cjs --stop

Frequently Asked Questions about markdown-novel-viewer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I render Markdown files as a book-like reader with syntax highlighting?

Markdown rendering converts your .md files to clean HTML with syntax highlighting using marked and highlight.js. Run the server with --file pointing to your Markdown document and --open to view it in a calm, distraction-free interface designed for reading.

Can I browse a directory of Markdown files and navigate between them?

Directory browsing lets you explore multiple Markdown documents in a folder structure. Use --dir to serve a directory, and the reader provides plan-aware navigation so you can move between related files without restarting the server.

How do I set up an HTTP server to view Markdown content locally or over a network?

The Node.js-based server starts via CLI with options for --host, --port, --file, and --dir. Specify --host 0.0.0.0 for remote access or leave it local; --open launches your browser automatically once the server is ready.

What keyboard shortcuts and controls does the Markdown reader include?

The reader supports keyboard navigation, theme toggling to switch between visual modes, and shortcuts for common reading actions. All controls are built into the HTML interface and documented within the reader itself.

Can I stop all running Markdown servers at once?

Yes, use --stop to cleanly shut down all active servers in one command. This prevents port conflicts if you start multiple instances.

Does the reader extract and display metadata like frontmatter from Markdown files?

Yes, gray-matter parses frontmatter from your Markdown files, extracting metadata like title and date without displaying it as body text, so you get clean content rendering with structured data available for navigation.