Skip to content

reallynattu/markview

Repository files navigation

Markview

Markview Logo

Beautiful Markdown, at a glance.
A minimalist, elegant markdown viewer and editor for macOS.

macOS License Built with

Markview Screenshot


โœจ Features

Core Features

  • ๐Ÿ“– Beautiful Reading Experience - Clean typography with customizable font pairings
  • โœ๏ธ In-Place Editing - Seamless toggle between view and edit modes
  • ๐ŸŽจ Multiple Themes - 9 beautiful color themes including Solarized, Nord, Dracula, and more
  • ๐ŸŒ“ Dark/Light Mode - Automatic theme switching based on system preferences
  • ๐Ÿ“ Typography Control - Adjustable font size and 10 curated font pairings

Performance & Navigation

  • โšก Lightning Fast - Instant file switching with intelligent caching
  • ๐Ÿ” Global Search - Search across all markdown files in your folder
  • ๐Ÿš€ Quick Open - Fuzzy file finder (โŒ˜P) like VS Code
  • ๐Ÿ“‘ Table of Contents - Navigate through document sections with collapsible outline
  • ๐Ÿ”Ž Search & Replace - Find and replace with regex support in edit mode
  • ๐Ÿ“‚ Smart Tabs - Multi-document interface that appears when needed

Export & Sharing

  • ๐Ÿ“ฅ Multi-Format Export - Export to PDF, HTML, and Word/DOCX
  • ๐Ÿ“ฆ Batch Export - Export multiple files at once
  • ๐Ÿ–จ๏ธ Print Preview - Preview before printing with custom styling
  • โš™๏ธ Export Options - Custom page settings and formatting options

Advanced Features

  • ๐ŸŽ™๏ธ Text-to-Speech - Natural voices powered by KittenTTS
  • ๐Ÿ”„ Auto Updates - Over-the-air updates with smart notifications
  • ๐Ÿš€ Performance Mode - Virtual scrolling for large files
  • ๐Ÿ”ง Debug Mode - Performance metrics and developer tools
  • ๐Ÿ’พ Smart Saving - Save with โŒ˜S, with full undo/redo support

File Management

  • ๐Ÿ“ Built-in File Browser - Navigate folders with a collapsible sidebar
  • ๐ŸŽฏ Drag & Drop Support - Drop files or folders directly onto the app
  • ๐Ÿ“Ž File Association - Set as default app for .md and .markdown files
  • ๐Ÿ“Œ Recent Files - Quick access to recently opened documents

Markdown Support

  • ๐Ÿ“Š GitHub Flavored Markdown - Tables, task lists, strikethrough, and more
  • ๐Ÿงฎ LaTeX Math Equations - Beautiful math rendering with KaTeX
  • ๐Ÿ“ˆ Mermaid Diagrams - Flow charts, sequence diagrams, and more
  • ๐ŸŽจ Syntax Highlighting - Code blocks with automatic language detection
  • ๐Ÿ”— Smart Links - Clickable URLs and email addresses

CLI Support

  • ๐Ÿš€ Command Line Interface - Open files with markview filename.md
  • โšก Quick Access - Launch Markview from anywhere in terminal
  • ๐Ÿ“ฆ Easy Installation - Install CLI directly from the app settings

๐Ÿ“ธ Screenshots

Light Theme

Markview Light Theme

Dark Theme

Markview Dark Theme

Settings & Themes

Markview Settings

File Browser

Markview File Browser

๐Ÿš€ Installation

Download Release (Recommended)

  1. Download the latest .dmg from Releases
  2. Open the downloaded DMG file
  3. Drag Markview to your Applications folder
  4. Launch from Applications (right-click โ†’ "Open" on first launch)

Install via Homebrew (Coming Soon)

brew install --cask markview

macOS Gatekeeper Issues

If you see "Markview can't be opened because it is from an unidentified developer" or "the file is corrupted" when installing the DMG, this is macOS Gatekeeper blocking the app. To fix this:

  1. First try right-clicking the app and selecting "Open"
  2. If that doesn't work, run this Terminal command:
sudo xattr -rd com.apple.quarantine "/Applications/Markview.app"

๐Ÿ“ Usage

Opening Files

  • Double-click any .md file (after setting as default app)
  • Drag & drop files or folders onto the app icon or window
  • Use sidebar buttons to browse for files or folders
  • Command line: markview README.md (after installing CLI)

Keyboard Shortcuts

Essential

Action Shortcut
Toggle Edit Mode โŒ˜E
Save โŒ˜S
Undo โŒ˜Z
Redo โŒ˜โ‡งZ
Open Settings โŒ˜,

Navigation

Action Shortcut
Quick Open โŒ˜P
Global Search โŒ˜โ‡งF
Toggle Table of Contents โŒ˜โ‡งO
Toggle Sidebar โŒ˜โŒฅS
Find & Replace (Edit Mode) โŒ˜F

Tabs

Action Shortcut
Close Tab โŒ˜W
Switch to Tab 1-9 โŒ˜1 - โŒ˜9

Text-to-Speech

Action Shortcut
Read Aloud โŒ˜R
Pause/Resume Space
Stop Reading Esc

Export

Action Shortcut
Export Document โŒ˜โ‡งE

Editing Workflow

  1. Open a markdown file
  2. Press โŒ˜E to enter edit mode
  3. Make your changes with live preview
  4. Press โŒ˜S to save
  5. Press โŒ˜E again to return to reading mode

๐ŸŽจ Themes

Markview includes 9 beautiful color themes:

  • Default (Light/Dark)
  • Solarized (Light/Dark)
  • Nord
  • Dracula
  • Rosรฉ Pine (Regular/Dawn)
  • Tokyo Night
  • One Dark

Access themes via Settings (โŒ˜,) โ†’ Color Theme

๐Ÿ”ง Building from Source

Prerequisites

  • Node.js 16+ and npm
  • macOS 10.15 or later
  • Xcode Command Line Tools

Build Steps

# Clone the repository
git clone https://github.com/yourusername/markview.git
cd markview

# Install dependencies
npm install

# Development mode with hot reload
npm run dev

# Build for production
npm run build

# Package for macOS
npm run dist:mac

Project Structure

markview/
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ main/           # Electron main process
โ”‚   โ””โ”€โ”€ renderer/       # React app
โ”œโ”€โ”€ resources/
โ”‚   โ”œโ”€โ”€ icons/          # App icons
โ”‚   โ””โ”€โ”€ cli/            # CLI scripts
โ”œโ”€โ”€ dist/               # Build output
โ””โ”€โ”€ build/              # Packaged apps

๐Ÿค Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Development Guidelines

  • Follow the existing code style
  • Add tests for new features
  • Update documentation as needed
  • Ensure all tests pass before submitting PR

๐Ÿ†• What's New in v1.1.0

Typography & Performance Update

  • Font Pairings - Choose from 10 curated font combinations
  • Lightning Fast - Instant file switching with caching
  • Virtual Scrolling - Smooth performance for large files
  • Debug Mode - Performance metrics and developer tools
  • UI Improvements - Cleaner interface with smart tab bar

See CHANGELOG.md for full release history.

๐Ÿ› Known Issues

  • Mermaid diagrams may take a moment to render on first load
  • Large files (>10MB) may experience slower performance
  • Some complex LaTeX equations might need page refresh

๐Ÿ“œ License

MIT License - see LICENSE file for details

๐Ÿ™ Acknowledgments


Markview - Your Markdown. Clear. Themed. Everywhere.
Made with โค๏ธ for the markdown community

About

A beautiful, open-source Markdown viewer with themes, folder navigation, and CLI support.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •