skills.rest
hidonguyen
hidonguyenCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

ck:markdown-novel-viewer

Serve markdown files as a book-like HTML viewer with mermaid rendering.

Updated Apr 2, 2026
Search Tags:#documentation#markdown#mermaid#viewer#directory-browser#http-server#novel-reader
One-click install
npx skills add https://github.com/hidonguyen/trade-ops --skill ck-markdown-novel-viewer-hidonguyen
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: ck:markdown-novel-viewer
Source: https://github.com/hidonguyen/trade-ops/tree/main/.opencode/skills/markdown-novel-viewer
Command: npx skills add https://github.com/hidonguyen/trade-ops --skill ck-markdown-novel-viewer-hidonguyen

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Provides a distraction-free, book-like HTTP viewer so users can read long-form markdown (documentation, plans, novels, reports) in the browser without manual HTML authoring or noisy UI chrome. It removes friction when previewing directories of markdown, resolving images, and navigating plan-style content on local machines or across a LAN.

Core Features & Use Cases

  • Background HTTP server that serves markdown files as a styled reader and directories as a clickable browser.
  • Client-side mermaid diagram rendering, syntax highlighting, theme toggle (light/dark), keyboard shortcuts, mobile FAB navigation, and focused reader UI with progress bar.
  • Safe file handling with allowed directory validation, /file/ image serving, port auto-selection, PID management for background instances, and back/next plan navigation for plan-based repos.
  • Use case: quickly preview a project's plan directory or a single long-form README with rich diagrams and readable typography on any device.

Quick Start

Start the server and open a markdown file by running the server script with the file path as the file argument.

Frequently Asked Questions about ck:markdown-novel-viewer

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

FAQPage Schema
How do I preview markdown files in a distraction-free reader?▼

You can preview markdown files in a distraction-free reader by running a background HTTP server that serves markdown as styled HTML. This viewer renders long-form text in the browser without manual HTML authoring or noisy UI chrome.

Can I render mermaid diagrams and syntax highlighting in a local markdown viewer?▼

Yes, you can render mermaid diagrams and syntax highlighting in a local markdown viewer. The viewer processes markdown client-side to display mermaid diagrams, apply syntax highlighting, and resolve relative images via dedicated file routes.

What is the best way to browse entire directories of markdown documentation locally?▼

Browsing directories of markdown documentation locally is best handled by an HTTP server that provides a clickable directory browser. It serves markdown files as a focused reader UI while offering safe file handling and navigation for plan-style repositories.

Does this markdown viewer support light and dark theme toggling?▼

Yes, this markdown viewer supports light and dark theme toggling. It includes a theme toggle feature alongside keyboard shortcuts, mobile FAB navigation, and a progress bar for comfortable long-form reading on any device.

How do I manage ports and background processes when serving markdown locally?▼

To manage ports and background processes when serving markdown locally, the viewer uses port auto-selection with auto-increment and PID-based background process control. This ensures safe file handling without port conflicts.

Can I use this markdown reader to preview files across a LAN?▼

Yes, you can use this markdown reader to preview files across a LAN. The background HTTP server supports local development and LAN access scenarios, allowing you to read project plans or reports on any device connected to the network.

Related Skills

Explore More Content & Communication Skills→
JNZaderJNZader

mermaid-validate

Validate Mermaid diagram syntax in Markdown files and directories.

Community
Intermediate
docaohieu2808docaohieu2808

markdown-novel-viewer

Render markdown files into an HTML book-like reading view via a local HTTP server.

Community
Intermediate
eugenelimeugenelim
15

markdown-to-html

Convert Markdown files into self-contained styled HTML pages.

Community
Advanced
channgchanng
20

docsify

Generate static documentation websites from markdown files with sidebar navigation.

Community
Basic