Skip to main content

Documentation 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.

This guide walks you from a fresh macOS install to a live, rendered Markdown preview in Finder. The whole process takes about two minutes. If you have already installed FluxMarkdown, skip to step 3.
1

Install FluxMarkdown

The fastest way is Homebrew:
brew install --cask xykong/tap/flux-markdown
Prefer a manual install? Download the DMG from the Releases page and drag FluxMarkdown.app to Applications. See Installation for all options.
2

Launch the app once

Open FluxMarkdown from your Applications folder. You will see a welcome screen — that is all you need. You do not have to open a file yet.
macOS will not activate a QuickLook extension until its host app has been launched at least once. This step is required even if you only plan to use the Space-bar preview in Finder.
3

Open a Markdown file in Finder

Navigate to any folder in Finder that contains a .md file. If you do not have one handy, create a quick test file. Open a text editor, paste the following content, and save it as test.md on your Desktop:
test.md
# Hello, FluxMarkdown

This is a **bold** statement and this is _italic_.

- Item one
- Item two
- [x] Task complete

## Math

Inline math: $E = mc^2$

Block math: $$\int_a^b f(x)\,dx = F(b) - F(a)$$
The file contains headings, formatted text, a task list, and KaTeX math expressions — a good test of the renderer.
4

Press Space to preview

Select the .md file in Finder (single-click), then press Space. The QuickLook panel opens with a fully rendered preview — headings, bold text, the task list, and the KaTeX math expressions all rendered inline.Press Space again (or Esc) to close the panel.

​
What you will see in the preview

The example file above demonstrates three of FluxMarkdown’s most distinctive features: Mermaid diagrams — any fenced code block tagged ```mermaid is rendered as an interactive diagram. FluxMarkdown supports flowcharts, sequence diagrams, Gantt charts, pie charts, and more. KaTeX math — wrap expressions in $...$ for inline math or $$...$$ for block math. The renderer uses KaTeX, so output matches what you would see in tools like Jupyter or Obsidian. Syntax highlighting — code blocks are highlighted for 40+ languages. You can choose the theme (GitHub, Monokai, Atom One Dark, and others) in Settings.

​
Keyboard shortcuts

You can control FluxMarkdown entirely from the keyboard.
ShortcutAction
SpaceOpen QuickLook preview in Finder
Cmd + / - / 0Zoom in / out / reset
Cmd Shift PExport document as PDF
Cmd Shift EExport document as HTML
Cmd ,Open Settings
See Keyboard shortcuts for the full reference.

​
QuickLook preview vs. opening in the app

There are two ways to view a Markdown file with FluxMarkdown: QuickLook (Space in Finder) — a floating panel that overlays Finder. Good for quickly reading a file without leaving your current context. Closes when you press Space or Esc, or click away. Main app (double-click) — opens the file in the FluxMarkdown window, which persists between sessions. The app remembers your scroll position and the last file you had open, so it picks up where you left off.
To make FluxMarkdown the default app when you double-click .md files, right-click any .md file in Finder, choose Get Info, expand Open with, select FluxMarkdown, and click Change All.

​
If the preview shows plain text

After installation, macOS occasionally needs a nudge to activate the extension. Run this in Terminal: 
qlmanage -r
qlmanage -r cache
killall Finder
Then try pressing Space again. If the problem persists, see Troubleshooting for a step-by-step diagnosis.

Build docs developers (and LLMs) love

Get started for freeTalk to us