Skip to content

A Chrome extension that automatically renders Markdown syntax in Apache dev mailing list emails.

License

Notifications You must be signed in to change notification settings

jason810496/apache-dev-mailing-markdown-extension

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Apache Dev Mailing List Markdown Renderer

License Chrome Extension Markdown GitHub

A Chrome extension that automatically renders Markdown syntax in Apache dev mailing list emails.

Demo
Demo Demo Demo

Features

  • Automatic markdown rendering: Detects and renders markdown syntax in email content
  • GitHub-flavored markdown: Supports GFM including tables, task lists, and code blocks
  • Clean styling: GitHub-style markdown rendering for better readability
  • Non-intrusive: Only processes content that contains markdown syntax

Installation

Load Unpacked Extension (Development)

  1. Open Chrome and navigate to chrome://extensions/
  2. Enable "Developer mode" using the toggle in the top right corner
  3. Click "Load unpacked" button
  4. Select the apache-dev-mailing-markdown-extension folder
  5. The extension should now be active

Using the Extension

  1. Navigate to any Apache mailing list page (e.g., https://lists.apache.org/)
  2. Open an email thread
  3. The extension will automatically detect and render markdown syntax in the email content
  4. Supported markdown features:
    • Headers (#, ##, etc.)
    • Bold (**text** or __text__)
    • Italic (*text* or _text_)
    • Links ([text](url))
    • Code blocks (```)
    • Inline code (`code`)
    • Lists (ordered and unordered)
    • Blockquotes (>)
    • Tables
    • And more!

Development

The extension uses:

  • Marked.js - Fast markdown parser and compiler
  • Content Scripts - Automatically runs on Apache mailing list pages
  • MutationObserver - Watches for dynamically loaded content

Files:

  • manifest.json - Chrome extension configuration
  • content.js - Main script that detects and renders markdown
  • styles.css - Styling for rendered markdown (GitHub-style)
  • marked.min.js - Markdown parser library
  • example.html - Example email content for testing

Permissions

The extension requires:

  • activeTab - To access and modify content on Apache mailing list pages

Special Thanks

Special thanks to the marked.js project for providing the fast and powerful markdown parser that makes this extension possible. Marked is a low-level markdown compiler for parsing markdown without caching or blocking for long periods of time.

License

Apache Dev Mailing List Markdown Renderer is licensed under the Apache License 2.0.

About

A Chrome extension that automatically renders Markdown syntax in Apache dev mailing list emails.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published