# markdown-novel-viewer

markdown-novel-viewer is a Claude Code skill that serves Markdown files as reading pages and directories as navigable lists. Read project plans and documentation in a browser.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 1 install · ★ 224 repo stars
- Author: NeverSight
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/NeverSight/learn-skills.dev/tree/HEAD/data/skills-md/duc01226/easyplatform/markdown-novel-viewer/SKILL.md
- Updated: 2026-10-29
- Security check: automated, 2026-11-16 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/skills/markdown-novel-viewer

## What it does

The skill serves Markdown files as reading pages and directories as navigable file lists. The viewer includes light and dark themes, code highlighting, and phase navigation when it detects a plan directory structure. You can move between phases with the arrow keys.

The server runs from `scripts/server.cjs` and accepts a file or directory path. It can open the browser automatically or run in the background. Node.js and the npm packages `marked`, `highlight.js`, and `gray-matter` are required; install them with `npm install` from the skill directory. Without those packages, Markdown rendering fails.

The default host is `localhost`, so access from another device requires `--host 0.0.0.0`. The default port is `3456`; if it is busy, the server picks another available port. Use `--stop` to stop running servers.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add NeverSight/learn-skills.dev --skill markdown-novel-viewer -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/markdown-novel-viewer/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/markdown-novel-viewer/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add NeverSight/learn-skills.dev --skill markdown-novel-viewer -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/markdown-novel-viewer/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add NeverSight/learn-skills.dev --skill markdown-novel-viewer -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/markdown-novel-viewer/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install NeverSight/learn-skills.dev data/skills-md/duc01226/easyplatform/markdown-novel-viewer
```

2. **Manually: put the files in place**
- File: `.github/skills/markdown-novel-viewer/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add NeverSight/learn-skills.dev --skill markdown-novel-viewer -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/NeverSight/learn-skills.dev --path data/skills-md/duc01226/easyplatform/markdown-novel-viewer
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/markdown-novel-viewer/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add NeverSight/learn-skills.dev --skill markdown-novel-viewer -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/NeverSight/learn-skills.dev/tree/HEAD/data/skills-md/duc01226/easyplatform/markdown-novel-viewer/SKILL.md

## When to use it
- open a Markdown file in a browser for reading
- browse a directory and follow links into subfolders
- navigate between phases in a detected plan
- run the Markdown viewer in the background
- stop active viewer servers

## Example prompts
- Open `README.md` in the browser with the Markdown viewer.
- Browse `plans/` and let me navigate to its files.
- Start a background view of `plans/my-plan/plan.md`.

## Similar
- [markdown-viewer-skills](https://affpapa.org/en/nevibecode/skills/markdown-viewer-skills.md) — skill · 202 installs
- [Web to Markdown](https://affpapa.org/en/nevibecode/skills/jackwener-web-to-markdown.md) — skill · ★ 239 repo stars
- [cmux-markdown](https://affpapa.org/en/nevibecode/skills/cmux-markdown.md) — skill · 7900 installs
- [markdown-mermaid-writing](https://affpapa.org/en/nevibecode/skills/markdown-mermaid-writing.md) — skill · 2300 installs
- [markdown-documentation](https://affpapa.org/en/nevibecode/skills/markdown-documentation.md) — skill · 1300 installs
- [verifying-markdown-formatting](https://affpapa.org/en/nevibecode/skills/verifying-markdown-formatting.md) — skill · 446 installs

From the same set: [neversight/learn-skills.dev](https://affpapa.org/en/nevibecode/by/neversight/learn-skills.dev.md) — 6 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
