markdown-novel-viewer

Name: markdown-novel-viewer
Availability: InStock
Author: hotriluan

Render Markdown documents into a book-like HTTP reading experience.

2|Updated Dec 24, 2025

Search Tags:#documentation #markdown #mermaid #syntax-highlighting #viewer #http-server

Ready to run

npx skills add https://github.com/hotriluan/alkana-dashboard --skill markdown-novel-viewer-hotriluan

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: markdown-novel-viewer
Source: https://github.com/hotriluan/alkana-dashboard/tree/main/.opencode/skill/markdown-novel-viewer
Command: npx skills add https://github.com/hotriluan/alkana-dashboard --skill markdown-novel-viewer-hotriluan

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 Markdown viewer serves long-form content with a distraction-free, book-like reading experience over HTTP, turning plain Markdown into a comfortable, navigable reader.

Core Features & Use Cases

Reading mode renders Markdown beautifully with serif headings and warm theming for focused reading.
Directory browsing lists directories with clickable links to view or navigate content.
Markdown rendering supports code blocks with syntax highlighting and Mermaid diagrams for diagrams and charts.
Use Case preview project docs, read internal docs, or review README files in a calm, distraction-free interface.

Quick Start

Run the server and open the provided URL to view Markdown files in a calm, book-like reader.

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 distraction-free reading mode over HTTP?▼

To view Markdown files in a distraction-free reading mode, you can render them over HTTP using a local server. This provides a book-like interface with warm theming, serif headings, and directory browsing for easy navigation.

Can I render Mermaid diagrams and syntax highlighting when viewing Markdown?▼

Yes, rendering Markdown supports syntax highlighting for code blocks using highlight.js and displays Mermaid diagrams. This ensures technical documentation remains readable and visual charts render correctly in the viewer.

Do I need Node.js and specific npm packages to serve Markdown content?▼

Yes, serving Markdown content requires Node.js and npm packages such as marked, highlight.js, and gray-matter. These dependencies parse, syntax-highlight, and render the Markdown documents into the final web view.

What is the best way to browse directories of internal documentation?▼

The best way to browse directories of internal documentation is using a viewer that lists directories with clickable links. This allows you to seamlessly navigate folders and preview project docs or README files in a calm interface.

Does this Markdown viewer support front matter in documentation files?▼

Yes, the viewer supports front matter in Markdown files using the gray-matter dependency. It parses metadata at the top of your documents before rendering the body content into the book-like reading experience.

Are there limitations when using a book-like Markdown reader for technical docs?▼

The primary limitation is that a book-like Markdown reader prioritizes calm reading over interactive editing. It is designed for viewing project docs and diagrams, not for modifying files or collaborating directly within the interface.