skills.rest
nguyenvanlinh1902
nguyenvanlinh1902COMMUNITY
Explore all skills by this author →
GitHub

markdown-novel-viewer

Serve Markdown files and directories as a book-like, keyboard-friendly HTTP reader with Mermaid.js support.

Updated Dec 16, 2025
Search Tags:#markdown#mermaid#docs#diagrams#reader#directory#viewer
One-click install
npx skills add https://github.com/nguyenvanlinh1902/trackingSolar --skill markdown-novel-viewer-nguyenvanlinh1902
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: markdown-novel-viewer
Source: https://github.com/nguyenvanlinh1902/trackingSolar/tree/main/.opencode/skill/markdown-novel-viewer
Command: npx skills add https://github.com/nguyenvanlinh1902/trackingSolar --skill markdown-novel-viewer-nguyenvanlinh1902

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

View markdown files with a calm, book-like reading experience via HTTP server. Use for long-form content, documentation preview, novel reading, report viewing, distraction-free reading.

Core Features & Use Cases

  • Novel Theme: warm cream background with serif headings, dark mode, and distraction-free reading
  • Mermaid.js Diagrams: auto-renders mermaid code blocks as diagrams
  • Directory Browser: directory listing with emoji icons and clickable links
  • Plan Navigation: auto-detects plan directory structure and provides phase-based navigation
  • Keyboard Shortcuts: quick access to theme, sidebar, and phase navigation

Quick Start

Start the server to view a Markdown file or browse a directory with node .opencode/skills/markdown-novel-viewer/scripts/server.cjs --file <path> --open or --dir <path> --open

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 with a distraction-free reading experience via HTTP?▼

To view markdown content via HTTP, run the server script using node with the --file or --dir option to render files in a calm, book-like reader interface with a warm cream background and serif headings.

Does this markdown reader support rendering mermaid diagrams and code blocks?▼

Yes, the viewer auto-renders mermaid code blocks as diagrams and syntax-highlights code blocks using highlight.js, enabling clear visualization of technical documentation directly in the browser.

Can I browse a directory of markdown files and navigate multi-phase plan structures?▼

Yes, the viewer provides a directory browser with clickable links and emoji icons via the --dir option, and auto-detects plan directory structures to generate a phase-based navigation sidebar.

What is the best way to preview long-form markdown novels and documentation locally?▼

Using this HTTP server is an effective way to preview long-form novels and documentation locally, as it enforces path safety, resolves image references to /file endpoints, and offers keyboard shortcuts for theme and sidebar toggling.

Do I need Node.js to run this markdown viewer server?▼

Yes, you need Node.js to execute the server script, which relies on dependencies including gray-matter for frontmatter parsing, marked for markdown conversion, and highlight.js for code syntax highlighting.

Related Skills

Explore More Content & Communication Skills→
mchien15mchien15

markdown-novel-viewer

Render Markdown documents in a book-like HTTP viewer.

Community
Intermediate
auxi-wardrobeauxi-wardrobe
1

markdown-novel-viewer

Render markdown files as novel-like reading experiences with diagrams.

Official
Intermediate
vuminhieuvuminhieu

markdown-novel-viewer

Render Markdown files and directories via a lightweight HTTP server.

Community
Intermediate
joonlabjoonlab
8

pdf-slide-viewer

Converts PDF documents into interactive HTML slide viewers with thumbnail navigation and fullscreen mode.

Community
Intermediate