Question 1

How do I install QLMarkdown on my Mac?

Accepted Answer

You can install it via Homebrew with 'brew install --cask qlmarkdown' or download from GitHub. Since it's not notarized, you may need to right-click to open or adjust security settings to bypass warnings.

Question 2

QLMarkdown vs MacDown: which is better for Markdown previews?

Accepted Answer

QLMarkdown excels for quick, integrated previews directly in Finder via Quick Look, while MacDown is a full editor. Choose QLMarkdown for speed and convenience, but MacDown if you need editing features.

Question 3

Does QLMarkdown support LaTeX math equations?

Accepted Answer

Yes, it uses MathJax to render both inline and block LaTeX math expressions, similar to GitHub's implementation, and supports dollar signs or code blocks for formatting.

Question 4

How to customize the theme in QLMarkdown?

Accepted Answer

Launch the QLMarkdown app, go to settings, select a built-in theme or add custom CSS. Ensure to save settings or enable autosave for changes to apply in Quick Look previews.

Question 5

Why does QLMarkdown show a security warning when I open it?

Accepted Answer

Because the app isn't signed or notarized by Apple. You can resolve this by right-clicking to open, using terminal commands like xattr, or allowing it in System Preferences as explained in the README.

Question 6

Can QLMarkdown render Mermaid diagrams without an internet connection?

Accepted Answer

Yes, Mermaid diagrams are rendered using a locally bundled JavaScript library (v10.9.3), so no network connection is required for diagram previews, and themes adapt to system appearance.

Question 7

How to batch convert Markdown files with QLMarkdown?

Accepted Answer

Use the included qlmarkdown_cli tool: create a symlink to your PATH, then run commands with options like -o for output directory and extensions flags to process multiple files into HTML.

QLMarkdown

What is QLMarkdown?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions