FluxMarkdown is a macOS QuickLook extension that renders Markdown files beautifully the moment you press Space in Finder. Instead of opening a separate editor, you get an instant, fully-styled preview — complete with Mermaid diagrams, KaTeX math, syntax-highlighted code blocks, charts, and more. It works with everyDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/xykong/flux-markdown/llms.txt
Use this file to discover all available pages before exploring further.
.md-family file format and requires no configuration to get started.
Features
Mermaid diagrams
Render flowcharts, sequence diagrams, Gantt charts, and more — directly from fenced code blocks.
KaTeX math
Inline and block mathematical expressions using LaTeX syntax, rendered with KaTeX.
GitHub Flavored Markdown
Full GFM support: tables, task lists, strikethrough, and GitHub-style callout alerts.
Syntax highlighting
Code blocks highlighted for 40+ languages using themes like GitHub, Monokai, and Atom One Dark.
Charts and graphs
Vega, Vega-Lite, and Graphviz DOT diagrams rendered inline alongside your Markdown.
Table of contents
An interactive TOC panel tracks your scroll position and lets you jump between sections.
Export
Export your document as a PDF or standalone HTML file with a single keyboard shortcut.
Themes
Light, Dark, and System-synced modes. Switch at any time from Settings.
How it works
FluxMarkdown uses a hybrid architecture. A lightweight native Swift app registers a QuickLook Preview Extension with macOS — this is what intercepts the Space key press in Finder. When you preview a file, the extension reads it and passes the raw Markdown text to a bundled TypeScript rendering engine running inside aWKWebView.
The renderer is built on markdown-it and extends it with purpose-built plugins for Mermaid, KaTeX, Vega, and Graphviz. The result is a single, self-contained HTML page that is displayed inside the QuickLook panel — no internet connection required.
This design means the rendering logic is easy to update independently of the Swift shell, and the preview is as fast as loading a local web page.
Comparison with other QuickLook plugins
| Feature | FluxMarkdown | QLMarkdown | qlmarkdown | PreviewMarkdown |
|---|---|---|---|---|
| Install | Homebrew / DMG | Homebrew / DMG | Manual | App Store / DMG |
| Mermaid | Yes | Yes | Not mentioned | Not mentioned |
| KaTeX / Math | Yes | Yes | Not mentioned | Not mentioned |
| GFM / Alerts | Yes | Yes | Partial | Not mentioned |
| TOC panel | Yes | Not mentioned | No | Not mentioned |
| Charts (Vega/DOT) | Yes | Not mentioned | No | No |
| Export (PDF/HTML) | Yes | No | No | No |
| YAML frontmatter | Yes | Yes | No | No |
| Themes | Light/Dark/System | CSS-based | Not mentioned | Basic controls |
| Zoom | Yes | Not mentioned | No | Not mentioned |
| Scroll restore | Yes | Not mentioned | No | No |
Feature entries are based on each project’s public README and release notes at the time of writing. “Not mentioned” means the feature was not documented in the project’s sources.
Supported file formats
FluxMarkdown automatically handles the following file extensions:.md · .mdx · .rmd · .qmd · .mdoc · .mmd · .livemd · .mkd · .mkdn · .mkdown · .mdwn · .mdown · .markdown
See File formats for details on format-specific behavior.