markdown-novel-viewer

Renders markdown files and directories as browsable HTML book-style pages via HTTP server.

Updated Feb 11, 2026
One-click install
npx skills add https://github.com/IoT-VN/tuya-energy-dashboard --skill markdown-novel-viewer-iot-vn
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdown-novel-viewer
Source: https://github.com/IoT-VN/tuya-energy-dashboard/tree/main/.opencode/skills/markdown-novel-viewer
Command: npx skills add https://github.com/IoT-VN/tuya-energy-dashboard --skill markdown-novel-viewer-iot-vn

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 distraction-free, book-like reading experience for markdown files and allows browsing directories through a web interface, making long-form content and documentation more accessible.

Core Features & Use Cases

  • Calm Reading Experience: Offers a warm, serif-font UI with customizable themes and layouts.
  • Directory Browser: Navigate and preview markdown files within a directory.
  • Mermaid Diagram Support: Renders diagrams directly within markdown.
  • Use Case: Quickly preview a long technical document, read a novel stored in markdown, or browse project documentation in a pleasant, focused environment.

Quick Start

Use the markdown-novel-viewer skill to view the file named 'README.md' in your current directory.

Frequently Asked Questions about markdown-novel-viewer

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

FAQPage Schema
How do I read markdown files with a book-like interface in my browser?

To read markdown files with a book-like interface, this Skill renders them into HTML via a local HTTP server, providing a calm, serif-font reading experience with customizable themes and layouts directly in your web browser.

Does this markdown viewer support rendering Mermaid.js diagrams?

Yes, this markdown viewer supports rendering Mermaid.js diagrams. It parses and displays Mermaid diagrams directly within your markdown files, allowing you to visualize complex technical documentation alongside standard text formatting.

Can I browse directories and preview markdown files through an HTTP server?

You can browse directories and preview markdown files through an HTTP server. The Skill includes a directory browser feature, allowing you to navigate folders and open markdown documents within a focused, web-based reading environment.

Do I need npm dependencies like marked and highlight.js to view markdown?

Yes, you need npm dependencies like marked, highlight.js, and gray-matter to view markdown. These packages are required for parsing frontmatter, rendering markdown syntax into HTML, and applying syntax highlighting to code blocks.

What is the best way to preview long technical documentation stored in markdown?

The best way to preview long technical documentation stored in markdown is using a dedicated viewer that offers a distraction-free UI, plan navigation, and syntax highlighting, making extensive technical content more accessible and readable.

Are there limitations when using markdown rendering for novels and large documents?

Limitations when using markdown rendering for novels include reliance on specific npm packages like marked and gray-matter for parsing, meaning your environment must support Node.js to run the HTTP server and render the HTML document properly.