Beautiful Reader

A beautiful reader for markdown and mermaid diagrams with elegant typography and customizable themes.

Installation

# Install globally
npm install -g beautiful-reader

# Or from source
cd beautiful-reader
npm install
npm link

Usage

# View a markdown file
beautiful-reader README.md

# View a mermaid diagram
beautiful-reader diagram.mermaid

# Pipe from stdin
cat README.md | beautiful-reader

# Options
beautiful-reader README.md --theme dark --fullscreen

Features

• Markdown Support: GFM with tables, task lists, strikethrough, and more
• Mermaid Support: Render complex diagrams including flowcharts, sequences, and architecture diagrams
• Syntax Highlighting: Code blocks with proper highlighting
• Multiple Font Presets: Choose from Classic, Literary, Modern, Elegant, Humanist, or Minimal
• Light & Dark Themes: Toggle between themes
• Full Screen Mode: Immersive reading experience
• Keyboard Shortcuts: Quick navigation and controls
• Font Size Control: Adjustable reading size (14px-24px)

Font Presets

1. Classic - Playfair Display / Crimson Pro - Traditional book typography
2. Literary - Libre Baskerville / Literata - Google's e-reader font
3. Modern - Inter / Source Serif 4 - Clean contemporary
4. Elegant - Cormorant / Cormorant Garamond - Refined beauty
5. Humanist - Alegreya / Lora - Warm, calligraphic
6. Minimal - IBM Plex Sans / IBM Plex Serif - Precise clarity

Keyboard Shortcuts

| Shortcut | Action | |----------|--------| | F11 | Toggle Fullscreen | | Cmd/Ctrl + Shift + T | Toggle Theme | | Cmd/Ctrl + , | Open Settings | | Cmd/Ctrl + 1-6 | Font Presets | | Cmd/Ctrl + + / - | Zoom In/Out | | Cmd/Ctrl + 0 | Reset Zoom | | Esc / Cmd/Ctrl + Q | Quit |

Code Example

import { Command } from 'commander';

const program = new Command();

program
  .name('beautiful-reader')
  .description('View markdown beautifully')
  .version('1.0.0');

program.parse();

Blockquote Example

Typography is the voice of your brand. Choosing a literary typeface creates a unique atmosphere that distinguishes your project from generic templates.

Lists

Unordered

• First item
• Second item
  • Nested item
  • Another nested item
• Third item

Ordered

1. First step
2. Second step
3. Third step

Task List

• [x] Learn markdown
• [x] Build beautiful viewer
• [ ] Deploy to npm

Enjoy beautiful reading! 📚