Skip to content

About

QuickLook plugin for Markdown files. – .md, .markdown

Topics

Resources

Stars

12 stars

Watchers

1 watching

Forks

Repository files navigation

macOS 10.15+ Current release All downloads

QLMarkdown

QuickLook plugin for Markdown files.

Stupidly simple. No configuration options, just Github flavored Markdown. But if you insist on modifying the stylesheet, you have full control over that.

screenshot

Installation

Requires macOS Catalina (10.15) or higher.

brew install --cask relikd/tap/relikd-qlmarkdown
xattr -d com.apple.quarantine /Applications/QLMarkdown.app

or download from releases.

Features

  • Small app size (6 MB)
  • Dark Mode
  • Auto-reload on file change (in App)
  • Customizable html output

auto-reload on file change

How to customize CSS

  1. Right click on the app and select "Show Package Contents"
  2. Open Contents/Resources and copy style.css (or markdown.css)
  3. Open ~/Library/Containers/de.relikd.QLMarkdown.Preview/Data/Documents/
  4. Paste the previous file(s) and modify it to your liking (e.g. change text colors)

To modify the app preview, the procedure is mostly the same, except in step 3 the path is:

~/Library/Containers/de.relikd.QLMarkdown/Data/Documents/

Scope of this project

This plugin is a wrapper around swift-markdown (which uses cmark-gfm) to convert markdown into html. No external binary is bundled into the app, everything is compiled directly into the app bundle. Output of the convert is passed, as is, to the preview window. Styling is applied via CSS (customizable) and mimics the GitHub stylesheet.

There wont be any configuration options, nor finetuning which options are active, and no additional features. If you want customizations, you can write your own css file.

Dependencies

Privacy & Security

Entitlements for the plugin allows access to all files (see App Sandbox Temporary Exception Entitlements). This enables referencing local files (e.g., image, etc).

However, this is also a privacy risk. A malicious QL plugin could send arbitrary file contents to a remote server. Be careful what plugins you install. Especially if it has both entitlements com.apple.security.temporary-exception.files and com.apple.security.network.client. Lucky for you, this open source project is very small and easy to review.

About

QuickLook plugin for Markdown files. – .md, .markdown

Topics

Resources

Stars

12 stars

Watchers

1 watching

Forks

Releases

Contributors

Languages