Code Monkey home page Code Monkey logo

qlmarkdown's Introduction

QLMarkdown

by Phil Toland http://fiatdev.com

fixes and improvements by Michael Dominic K. http://www.mdk.org.pl

Introduction

QLMarkdown is a simple QuickLook generator for Markdown files. It renders a preview of the selected Markdown file using Discount -- a C implementation of John Gruber's Markdown.pl script.

To update to the latest version of discount run ./discount-config/update-discount.sh

For more information on Markdown see http://daringfireball.net/projects/markdown/.

Installation

Simply copy QLMarkdown.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 QLMarkdown into the trash.

Another method, provided you have Homebrew Cask installed, you can run the following commands to set things up:

$ brew update

$ brew cask install qlmarkdown

To uninstall:

$ brew cask uninstall qlmarkdown

Note: QuickLook doesn't allow selecting text by default. If you want to select the text in the markdown preview, you will need to enable text selection in QuickLook by running the following command in Terminal:

defaults write com.apple.finder QLEnableTextSelection -bool TRUE; killall Finder

This command is only valid on OS X 10.10 and below as Apple has since removed the ability to select text in QuickLook.

Downloads

Source code is available at http://github.com/toland/qlmarkdown.

You can download the latest release from https://github.com/toland/qlmarkdown/releases

License

The QLMarkdown code is distributed under the same terms as Discount. See the file discount/COPYRIGHT for more information.

Version History

Version 1.3 - Jan 26, 2012

  • Major update of discount markdown engine

Version 1.2 - Oct 4, 2009

  • Work around a conflict with MacVim (thanks to godDLL)
  • Support for .mdml extension (alanhogan)
  • CSS that mimics Apple's ADC styling (jiho)

Version 1.1 - Feb 11, 2009

  • Adding a little bit of CSS styling. (mdk)
  • Replace the Perl markdown renderer with a native C one (discount). (mdk)
  • Conform to public plain-text. Will make spotlight index the file contents. (mdk)
  • Added support for .md file extension (sant0sk1)

Version 1.0 - July 15, 2008

  • Initial release.

qlmarkdown's People

Contributors

tarwich avatar silum avatar mdk avatar booch avatar ktf avatar sparanoid avatar maddthesane avatar jiho avatar rchowe avatar alanhogan avatar ctesniere avatar hivehand avatar jerodsanto avatar th507 avatar mathiasbynens avatar cliotropic avatar thomasaw avatar vitorgalvao avatar vividvisions avatar chrisfinazzo avatar dbr avatar josiahwiebe avatar majjoha avatar

Watchers

Nik avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.