A lightweight, open-source markdown viewer for Chrome, Edge & Chromium Browsers. This repository provides the core rendering engine with essential features, designed for transparency, security auditing, and self-hosted deployments.
Note: This is the open-source version of MarkView. For the full-featured extension with advanced productivity tools, visit MarkView on Chrome Web Store or MarkView on Edge Add-ons.
- ✅ Full GFM Support - GitHub Flavored Markdown (tables, task lists, strikethrough, footnotes)
- ✅ Syntax Highlighting - Code blocks with basic theme (180+ languages supported)
- ✅ Mermaid Diagrams - Flowcharts, sequence diagrams, class diagrams, and more
- ✅ KaTeX Math Rendering - Beautiful LaTeX equations (inline and display)
- ✅ Dark/Light Themes - Eye-friendly theme toggle
- ✅ Basic Table of Contents - Auto-generated TOC for H1-H2 headings
- ✅ GitHub-Style Alerts - Note, Tip, Important, Warning, Caution callouts
- ✅ Extended Markdown - Superscript, subscript, insert, mark, abbreviations, definition lists
- ✅ Local & Remote Files - View markdown from file:// and https:// URLs
- ✅ Privacy-First - All processing happens locally, no data collection
Get the complete MarkView experience with all productivity features:
- Chrome Web Store - For Chrome & Chromium-based browsers
- Microsoft Edge Add-ons - For Edge browser
- Official Website - Learn more about features
For developers, security auditing, or restricted environments:
# Clone the repository
git clone https://github.com/markview-app/markview.git
cd markview
# Install dependencies (requires pnpm)
pnpm install
# Build the extension
pnpm run build
# Load the unpacked extension
# 1. Open chrome://extensions/
# 2. Enable "Developer mode"
# 3. Click "Load unpacked"
# 4. Select the `dist/` folderRequirements: Node.js 18+, pnpm 8+
Choose Open-Source Edition if you:
- Need to audit the code for security/privacy
- Work in a corporate environment requiring open-source software
- Want a lightweight viewer for basic markdown files
- Need to self-host or modify the extension
- Are in a region where Chrome Web Store is blocked
Choose Full Extension if you:
- Want productivity features like folder navigation and folder bookmarks
- Want presentation mode for markdown slides
- Need export to HTML and Word documents
- Need advanced features like Mermaid fullscreen zoom, image viewer with gallery navigation
- Prefer automatic updates from Chrome Web Store
- And many more!
- Upgrade Guide - How to migrate to the full extension
- Development Guide - Build, test, and contribute
- Contributing Guidelines - How to contribute
- Architecture Overview - Technical documentation
- TypeScript 5.0+ - Type-safe development
- Webpack 5 - Module bundling with esbuild-loader
- markdown-it 14.1.0 - Markdown parser with plugin ecosystem
- highlight.js 11.6.0 - Syntax highlighting
- Mermaid 11.4.0 - Diagram rendering
- KaTeX 0.16.25 - Math equation rendering
- Chrome Extension Manifest V3 - Modern extension platform
See package.json for complete dependencies.
We welcome contributions to the core rendering features! Please read our Contributing Guidelines before submitting a pull request.
✅ Welcome Contributions:
- Bug fixes in core rendering
- Performance improvements
- New markdown-it plugins (if useful for everyone)
- Documentation improvements
- Translation improvements
- Accessibility enhancements
- Security fixes
❌ Not Accepting:
- PRO-tier features (maintained separately)
- Features that significantly increase bundle size
- Breaking changes to existing APIs
- Bug Reports: GitHub Issues
- Feature Requests: GitHub Issues
- Questions: GitHub Discussions
- Full Extension Support: MarkView Support
This open-source edition is released under the MIT License. See LICENSE for details.
Note: This is the open-source version of MarkView. For the full-featured extension with advanced productivity tools, visit MarkView on Chrome Web Store or MarkView on Edge Add-ons.
- Website: https://getmarkview.com/
- Chrome Web Store: Install Extension
- Edge Add-ons: Install Extension
- Support & FAQ: https://getmarkview.com/support
- Privacy Policy: https://getmarkview.com/privacy-policy
- Main Support Repository: markview-app/support
- Sample Markdown Files: markview-app/sample-markdown
- Organization Profile: markview-app
If you find this project useful:
- ⭐ Star this repository on GitHub
- 🐦 Share it on social media
- 📝 Write a review on Chrome Web Store
- 💬 Join discussions in GitHub Discussions
- 🚀 Upgrade to PRO to support continued development
See CHANGELOG.md for release history.
Made with ❤️ by the MarkView Team