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.
FluxMarkdown installs as a standard macOS application. Once installed, it registers a QuickLook Preview Extension with the system — no extra configuration needed. Choose the method that suits you best: Homebrew for the quickest path, DMG for a manual install, or building from source if you want to run the latest code.
System requirements
- macOS: A version that supports QuickLook Preview Extensions (macOS 10.15 Catalina or later is recommended)
- Architecture: Apple Silicon (arm64) and Intel (x86_64)
- Disk space: ~30 MB
Installation
Homebrew (recommended)
DMG (manual)
Build from source
Homebrew is the fastest way to install and keep FluxMarkdown up to date.Install via Homebrew Cask
Run the following command in Terminal:brew install --cask xykong/tap/flux-markdown
xykong/tap repository and installs the latest release of FluxMarkdown. Launch the app once
Open FluxMarkdown from your Applications folder. The welcome screen appears briefly — this step registers the QuickLook extension with macOS.macOS requires a QuickLook extension’s host app to be launched at least once before the extension becomes active. Skipping this step means previews will not work yet.
Verify the preview works
In Finder, select any .md file and press Space. You should see a rendered Markdown preview instead of plain text.
brew update && brew upgrade --cask flux-markdown
Download and install the app directly if you prefer not to use Homebrew.Download the latest release
Go to the Releases page on GitHub and download the latest FluxMarkdown.dmg. Open the DMG
Double-click the downloaded .dmg file to mount it.
Copy to Applications
Drag FluxMarkdown.app into the Applications folder shown in the DMG window.
Launch the app once
Open FluxMarkdown from Applications. This registers the QuickLook extension with macOS.If macOS shows an “App is damaged” or “unidentified developer” warning, run the following in Terminal and then try opening the app again:xattr -cr "/Applications/FluxMarkdown.app"
Verify the preview works
Select a .md file in Finder and press Space to confirm the preview renders correctly.
Build FluxMarkdown yourself if you want to run the latest unreleased code or contribute to the project.Install prerequisites
You need Xcode (with command-line tools), xcodegen, and Node.js.brew install xcodegen node
Clone the repository
git clone https://github.com/xykong/flux-markdown.git
cd flux-markdown
Build and install
This runs the full pipeline: builds the TypeScript web renderer (npm install && npm run build), generates the Xcode project via xcodegen, compiles the macOS app, and copies it to /Applications. Launch the app once
Open FluxMarkdown from Applications to register the QuickLook extension.open /Applications/FluxMarkdown.app
Verify the preview works
Select a .md file in Finder and press Space.
The .xcodeproj file is generated — do not commit it. All project configuration lives in project.yml. See the Developer Guide for more. After installation: verify the extension is registered
If you want to confirm that macOS has registered the QuickLook extension correctly, run the following in Terminal:
pluginkit -m -v | grep -i markdownquicklook
com.markdownquicklook.app.MarkdownPreview. If nothing appears, try launching the app again, then run qlmanage -r && killall Finder to refresh the QuickLook cache.
Troubleshooting
If previews show plain text instead of rendered Markdown after installation:
qlmanage -r
qlmanage -r cache
killall Finder