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.

FluxMarkdown renders your .md and .mdx files using a complete stack of Markdown extensions: GitHub Flavored Markdown (GFM), KaTeX for math, Highlight.js for code, and a suite of extended-syntax plugins for footnotes, subscripts, highlights, and smart punctuation. Every feature described here works in both QuickLook preview and the standalone app.

​
GitHub Flavored Markdown

FluxMarkdown uses markdown-it with the markdown-it-github-alerts plugin and enables all standard GFM constructs.

Tables

Standard pipe-delimited tables render with proper header alignment:
| Feature    | Status | Notes              |
|------------|:------:|-------------------|
| Tables     |   ✅   | Alignment supported |
| Task lists |   ✅   | Interactive checkboxes |
Checkboxes render visually. They are read-only in QuickLook mode.
- [x] Install FluxMarkdown
- [x] Open a Markdown file with Space
- [ ] Configure your preferred theme
Wrap text in ~~double tildes~~ to produce struck-through text.
~~deprecated syntax~~ → rendered as struck-through
FluxMarkdown renders all five GitHub alert types:
> [!NOTE]
> Highlights information that users should take into account.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]
> Crucial information necessary for users to succeed.

> [!WARNING]
> Critical content demanding immediate user attention.

> [!CAUTION]
> Negative potential consequences of an action.
Each alert renders with the matching colour, icon, and label from GitHub’s own spec.

​
KaTeX math

Math is rendered by KaTeX and loaded on demand — it is only activated when the parser detects $…$ or $$…$$ delimiters in the document, keeping documents without math fast.
Wrap an expression in single dollar signs on the same line as surrounding text:
Einstein's famous equation: $E = mc^2$

The quadratic formula is $x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}$.
KaTeX rendering can be toggled in Settings → Rendering → KaTeX. When disabled, the $…$ delimiters are shown as plain text.

​
Syntax highlighting

Code fences are highlighted by Highlight.js with support for 40+ languages. Specify the language immediately after the opening triple backticks: 
```python
def greet(name: str) -> str:
    return f"Hello, {name}!"
```
Supported languages include:

Systems & web

C, C++, Go, Rust, Swift, Kotlin, Objective-C, Java, C#, TypeScript, JavaScript, PHP, Ruby

Scripting & data

Python, Bash, Shell, PowerShell, R, Lua, Perl, Haskell, Elixir, Groovy, Scala, Dart

Config & markup

JSON, YAML, TOML, XML, HTML, CSS, SQL, Dockerfile, Nginx, Makefile, Protobuf, GraphQL, Diff
Common aliases are supported so you can write js, ts, py, sh, rb, kt, cs, objc, ps1, proto, gql, hs, ex, or exs and they resolve to the correct grammar. The active highlighting theme is controlled in Settings → Editor → Code highlight theme. See Themes and appearance for the available options.

​
Extended syntax

FluxMarkdown ships several markdown-it plugins beyond the GFM baseline.
Use [^label] inline and define the note content anywhere in the document:
Markdown is widely used[^1] in technical writing.

[^1]: Markdown was created by John Gruber in 2004.
Footnotes render at the bottom of the preview with back-links to the reference site.
Water is H~2~O.
The area is r^2^π.
Subscript uses ~text~; superscript uses ^text^.
Mark important text with double equals signs. It renders as an HTML <mark> element:
This is ==highlighted text== inside a sentence.
The typographer mode transforms plain ASCII punctuation into proper typographic characters:
InputOutput
"hello"”hello”
'world'’world’
--– (en dash)
---— (em dash)
...… (ellipsis)

​
YAML frontmatter

If your document begins with a ----delimited YAML block, FluxMarkdown parses it and renders the key-value pairs as a clean table above the document body — no raw YAML is shown. 
---
title: My Research Note
author: Jane Smith
date: 2026-05-01
tags: [markdown, research, notes]
draft: false
---

# Introduction

Body text begins here.
The parsed frontmatter appears as a styled metadata table at the top of the preview. Nested objects render as indented sub-tables; arrays render as bullet lists.
Frontmatter is purely presentational in FluxMarkdown. The file on disk is never modified.

​
RTL language support

FluxMarkdown automatically detects right-to-left content. When more than 30% of the document’s characters are RTL script (Arabic, Hebrew, Persian, etc.), the preview applies dir="rtl" to the content container. Switching back to a Latin-script document removes the attribute immediately. No configuration is required — detection is fully automatic.

Diagrams and charts

Mermaid, Vega/Vega-Lite, and Graphviz DOT support

Themes and appearance

Light, dark, system themes and code highlight options

Build docs developers (and LLMs) love

Get started for freeTalk to us