FluxMarkdown is a macOS QuickLook extension that renders Markdown files beautifully directly in Finder. Press Space on anyDocumentation 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 file to see a fully-rendered preview complete with diagrams, math expressions, syntax-highlighted code, and more — no external app required.
Installation
Install FluxMarkdown via Homebrew or DMG in under 30 seconds
Quickstart
Get your first Markdown preview working in Finder right away
Features
Explore Mermaid, KaTeX, charts, export, themes, and more
Troubleshooting
Fix common QuickLook registration and preview issues
What FluxMarkdown renders
FluxMarkdown supports a rich set of Markdown features out of the box — everything you need for technical writing, note-taking, and documentation.Diagrams & Charts
Mermaid flowcharts, Vega charts, and Graphviz DOT diagrams
Math Expressions
KaTeX inline and block math for scientific and technical content
Export
Export to PDF or HTML with a single keyboard shortcut
Themes
Light, Dark, and System-synced themes with code highlighting options
Get started in 30 seconds
Launch the app once
Open FluxMarkdown from Applications to register the QuickLook extension with macOS.
If the preview still shows plain text after installation, try running
qlmanage -r && killall Finder in Terminal, then try again. See Troubleshooting for more.Supported file formats
FluxMarkdown recognizes.md, .mdx, .rmd, .qmd, .mdoc, .mmd, .livemd, .mkd, .mkdn, .mkdown, .mdwn, .mdown, and .markdown files automatically.
For developers
Interested in contributing or building from source? FluxMarkdown uses a hybrid architecture — a native Swift host app with a TypeScript web renderer powered bymarkdown-it, Mermaid, KaTeX, and highlight.js.
Architecture
Understand the Swift + TypeScript hybrid design
Development Setup
Build FluxMarkdown from source and run the renderer