开源软件名称（OpenSource Name）：

开源软件地址(OpenSource Url)：

开源编程语言(OpenSource Language)：

开源软件介绍(OpenSource Introduction)：

QLMarkdown

QLMarkdown is a macOS Quick Look extension to preview Markdown files.

This application is not intended to be used as a standalone markdown file editor or viewer.

Please note that this software is provided "as is", without any warranty of any kind.

The Quick Look extension can also preview rmarkdown (.rmd) files (without evaluating r code), Quarto files (.qmd) and textbundle packages.

You can download the last compiled release (as universal binary) from this link.

• Screenshots
  • Quick Look Markdown preview
• Installation
• Markdown processing
• Difference with the GitHub Markdown engine
• Settings
  • Themes
  • Basic options
  • Advanced options
  • Extensions
    • Emoji
    • Inline local images
    • Syntax Highlighting
    • YAML header
• Command line interface
• Build from source
  • Dependency
• Note about security
• Note about the developer

Screenshots

Quick Look Markdown preview

Installation

You can download the last compiled release (as universal binary) from this link or you can install the Application with Homebrew:

brew install --cask qlmarkdown

The precompiled app is not notarized or signed, so the first time you run the app the system may show a warning about the impossibility to check for malicious software.

To fix, you can launch the app with right click (or ctrl click) on the app icon and choose the open action.

You can also execute this command from the terminal:

$ xattr -r -d com.apple.quarantine "FULL PATH OF THE QLMarkdown.app (you can drag the file to get the pull path)"

Alternatively, after trying to launch the app for the first time, you can open the System Preferences > Security & Privacy > General (tab) and click the Open Anyway button.

This will resolve the error of an unsigned application when launching the app.

To use the Quick Look preview you must launch the application at least once. In this way the Quick Look extension will be discovered by the system. After the first execution, the Quick Look extension will be available (and enabled) among those present in the System preferences/Extensions.

If you have problems, try moving the application to the trash and then back in the Applications folder. If the QLMarkdown Preview Extension is present (and checked) in the list of Quick Look Extensions in the System preferences but the .md files are not displayed it is probably due to other applications that have registered support for that type of file. You can change the order of priority of the Quick Look Extensions inside the System preferences.

Finally, the problems may depend on how the .md files were registered on the system by other applications.

In the terminal try the following command:

mdls -name kMDItemContentType PATH_OF_AN_EXISTS_MD_FILE

The output is the UTI associated with the .md file.

This application handle these UTIs:

• com.rstudio.rmarkdown
• com.unknown.md
• net.daringfireball.markdown
• net.ia.markdown
• org.quarto.qmarkdown
• public.markdown
• org.textbundle.package
• dyn.ah62d4rv4ge8043a (dynamic UTI for unassociated .md files)
• dyn.ah62d4rv4ge81e5pe (dynamic UTI for unassociated .rmd files)
• dyn.ah62d4rv4ge81c5pe (dynamic UTI for unassociated .qmd files)

Please inform me of any other UTI associated to .md files.

Markdown processing

For maximum compatibility with the Markdown format, the cmark-gfm library is used. The library is a GitHub fork of the standard cmark tool to process the Markdown files.

Compared to the cmark-gfm, these extensions have been added:

• Emoji: translate the emoji placeholders like :smile: to