English | 中文 | 한국어

A markdown reader extension for Chrome.

Support view file:// http:// https:// URL and *.md *.mkd *.markdown extension files.

Example:

• https://example.com/example.md
• file:///Users/my-project/readme.markdown

• Render markdown to HTML
• Table of content sidebar
• RAW preview
• Image preview
• Code highlighting
• Light/Dark/Auto markdown theme
• Shortcut key
• Document hot reload
• Page content centered
• Plugins:
  • Emoji
  • Superscript
  • Subscript
  • Inserted
  • TOC
  • Mark
  • Katex
  • Mermaid
  • Abbreviation
  • Definition list
  • Footnote
  • Task Lists
  • Warning container
  • Tips container
• Support OS:
  • Windows
  • macOS
  • Linux
  • Ubuntu
  • ChromeOS

Install from the chrome extension store.

1. Clone md-reader repo and build:

   # Clone repository
   git clone https://github.com/Heroor/md-reader.git && cd md-reader
   
   # Install dependencies
   pnpm install
   
   # Build extension
   pnpm build

2. After build, the md-reader/dist folder will generate a md-reader-xxx.zip extension package.

3. On the Chrome extension management page and drag the extension into the browser.

After installation, you should set local file access permissions before preview local files:

Open details page of md-reader extension, enabled Allow access to file URLs.

All right!

Visit this example.md to test if it works, Or drag markdown file to the Chrome!

# Clone repository
git clone https://github.com/Heroor/md-reader.git && cd md-reader

# Installation dependencies
pnpm install

# Develop project
pnpm dev

On the Chrome extension management page, click "Load unpacked extension" and select md-reader/extension directory.

License MIT

© 2018-present, Bener