https://github.com/Watson1978/QLMarkdownGFM

Quicklook plugin for Github Flavored Markdown
https://github.com/Watson1978/QLMarkdownGFM

Last synced: 13 days ago
JSON representation

Quicklook plugin for Github Flavored Markdown

• Host: GitHub
• URL: https://github.com/Watson1978/QLMarkdownGFM
• Owner: Watson1978
• License: bsd-3-clause
• Created: 2018-04-08T09:23:15.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-28T22:31:24.000Z (14 days ago)
• Last Synced: 2024-10-28T23:24:59.523Z (14 days ago)
• Language: C
• Homepage:
• Size: 1.45 MB
• Stars: 53
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• Mac-QuickLook - QLMarkdownGFM

README

        
# QLMarkdownGFM

## Introduction

QLMarkdownGFM is macOS Quick Look plugin for Github Flavored Markdown. This renders a thumbnail or preview using [github/cmark](https://github.com/github/cmark).

> [!IMPORTANT]  

> This plugin does not work since macOS 15, because it deprecates Quick Look Generator plugins.

> https://developer.apple.com/documentation/macos-release-notes/macos-15-release-notes#Quick-Look

Here is QLMarkdownGFM screenshots.

Thumbnail | Preview

-- | --

 | 

## Installation

If you have been used other QuickLook plugin, please remove it before (See https://github.com/Watson1978/QLMarkdownGFM/issues/3).

### By homebrew-cask

If you use [homebrew-cask](https://github.com/Homebrew/homebrew-cask), you can install this by following command.

```

$ brew tap Watson1978/formula

$ brew install --cask watson1978/formula/qlmarkdowngfm

```

To uninstall,

```

$ brew uninstall --cask watson1978/formula/qlmarkdowngfm

$ brew untap Watson1978/formula

```

### By manual

Simply copy QLMarkdownGFM.qlgenerator to `~/Library/QuickLook` or `/Library/QuickLook`.

If the newly installed plugin is not picked up instantly, you can run `qlmanage -r` in Terminal to refresh.

To uninstall, drag QLMarkdownGFM into the trash.