Skip to content

iafan/markdown-viewer-chrome-extension

Repository files navigation

Markdown Viewer

Markdown Viewer

An unobtrusive Chrome extension that renders Markdown files in the browser.

Preview

Features

  • Auto-renders .md and .markdown files
  • Syntax highlighting for code blocks
  • Light/dark theme with auto-detection
  • YAML and JSON frontmatter rendering
  • Mermaid flowchart rendering (sort of — this is still experimental)
  • ASCII tree structure rendering (this is what I was missing everywhere else!)
  • Toggle prettifying on/off via context menu

Installation

From Source

  1. Install dependencies and build:

    npm install
    npm run build
  2. Open Chrome and go to chrome://extensions/

  3. Enable "Developer mode" (toggle in top right)

  4. Click "Load unpacked" and select the dist folder

  5. For local files, click "Details" on the extension and enable "Allow access to file URLs"

Usage

  • Auto-render: Opens .md or .markdown files and automatically renders them
  • Context menu: Right-click on any page and select "Prettify Markdown" to render, or "View raw Markdown" to revert
  • Toolbar icon: Click the extension icon to toggle between rendered and raw markdown

Dependencies

This extension uses the following packages:

License

This is free and unencumbered software released into the public domain (Unlicense).

About

Markdown Viewer - Chrome Extension

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors