markdown-novel-viewer

Convert Markdown files into an HTML-based book-like reader.

1|Updated Jun 16, 2026
One-click install
npx skills add https://github.com/TNHoang2708/Gym_Ver2 --skill markdown-novel-viewer-tnhoang2708
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdown-novel-viewer
Source: https://github.com/TNHoang2708/Gym_Ver2/tree/main/.claude/skills/markdown-novel-viewer
Command: npx skills add https://github.com/TNHoang2708/Gym_Ver2 --skill markdown-novel-viewer-tnhoang2708

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill turns Markdown files into a pleasant, distraction-free reading experience, perfect for long-form content like novels, documentation, and reports.

Core Features & Use Cases

  • Book-like Reading: Provides a serene reading interface with serif fonts and a warm theme.
  • Mermaid.js Diagrams: Automatically renders Mermaid diagrams for visual clarity.
  • Directory Browser: Navigate directories and view file listings with ease.
  • Focused Reader Mode: Auto-hide header, progress bar, and minimal UI for an immersive reading experience.
  • Mobile Optimization: Optimized for mobile devices with a floating action button and bottom sheet sidebar.
  • Quick Start: Use the /ck:preview command followed by the path to the Markdown file or directory.

Quick Start

To view a Markdown file, use the command: /ck:preview path/to/your/file.md

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 as a distraction-free book-like reader?

To view Markdown files as a book-like reader, use the `/ck:preview` command followed by your file or directory path. This transforms your text into a serene reading interface with serif fonts and a warm theme.

Can I render Mermaid diagrams when converting Markdown to HTML?

Yes, rendering Mermaid diagrams is fully supported when converting Markdown to HTML. The reader automatically processes and displays Mermaid.js diagrams to provide visual clarity for your documentation.

Do I need Node.js and npm packages to convert Markdown into a reading experience?

Yes, you need Node.js and npm packages like marked, highlight.js, and gray-matter to convert Markdown into a reading experience. These dependencies handle HTTP requests, file serving, and Markdown rendering.

Does the Markdown reader support mobile devices and directory browsing?

Yes, the Markdown reader supports mobile devices and directory browsing. It features a floating action button with a bottom sheet sidebar for mobile, and allows you to navigate directories and view file listings easily.

What is the best way to read long-form Markdown novels on mobile?

The best way to read long-form Markdown novels on mobile is using a focused reader mode that auto-hides the header and provides a minimal UI. This ensures an immersive, optimized reading experience on small screens.

Are there limitations when using highlight.js and gray-matter for Markdown rendering?

Limitations when using highlight.js and gray-matter for Markdown rendering include relying on a Node.js environment and specific dependencies. The system is intended strictly for document viewing and content consumption.