markdown-novel-viewer

Render Markdown files and directories via a lightweight HTTP server.

Updated Feb 2, 2026
One-click install
npx skills add https://github.com/vuminhieu/spexor-client --skill markdown-novel-viewer-vuminhieu
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdown-novel-viewer
Source: https://github.com/vuminhieu/spexor-client/tree/main/.agent/skills/skills/markdown-novel-viewer
Command: npx skills add https://github.com/vuminhieu/spexor-client --skill markdown-novel-viewer-vuminhieu

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill renders Markdown content via a lightweight HTTP server, delivering a distraction-free, book-like reading experience for both files and directories.

Core Features & Use Cases

  • Markdown File View: Open and render Markdown files with a serif-focused reading UI and ambient theme.
  • Directory Browser: Browse folders with clickable links and a clean file listing.
  • Mermaid Diagrams: Auto-render Mermaid blocks for visual diagrams within Markdown.
  • Remote Access: Serve content locally or over the network for collaborative reading and review.

Quick Start

Install dependencies and start the server:

  • npm install
  • npm start Then view a file: http://localhost:3456/view?file=README.md Or browse a directory: http://localhost:3456/browse?dir=plans

Frequently Asked Questions about markdown-novel-viewer

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

FAQPage Schema
How do I view Markdown files in a book-like reading format over HTTP?

You can render Markdown files into a readable, book-like HTML interface by running a lightweight Node.js HTTP server. This server parses Markdown content and serves it locally or over the network for distraction-free viewing.

Can I browse directories and render Markdown files on a local network?

Yes, you can browse directories and render Markdown files on a local network. The server provides a directory browser with clickable links and clean file listings, allowing remote access for collaborative reading.

Does this Markdown reader support syntax highlighting and Mermaid diagrams?

Yes, this Markdown reader supports syntax highlighting and Mermaid diagrams. It uses the highlight.js library for code syntax highlighting and automatically renders Mermaid blocks for visual diagrams within the Markdown content.

Do I need Node.js and npm dependencies to serve Markdown content?

Yes, you need Node.js and npm to install required dependencies. The viewer relies on the marked, highlight.js, and gray-matter npm packages to parse Markdown, highlight code syntax, and process front matter.

What is the best way to share Markdown documentation for collaborative review?

The best way to share Markdown documentation for collaborative review is by running a lightweight HTTP server. It renders files into a readable interface accessible over the network, enabling multiple users to review the same content.