Igor Kromin |   Consultant. Coder. Blogger. Tinkerer. Gamer.

NOTE: This article is 3 years or older so its information may no longer be relevant. Read on at your own discretion! Comments for this article have automatically been locked, refer to the FAQ for more details.
If you do any kind of software development or use any open source software the chances are that you have come across Markdown files, typically something like README.md. If you're on OS X, there is no easy way to view these out of the box. This is where qlmarkdown comes to the rescue. It's a QuickLook addon that renders the Markdown formatted files directly in the quick look window.

This is what the output of qlmarkdown looks like (pressing the space bar on a Markdown file in Finder):

This addon registers itself to respond to the following file extensions:
  • multimarkdown
  • markdown
  • mdown
  • md
  • mdml
  • text
  • mdwn
  • mkd
  • mmd

Installation is really easy, simply download the zip file from https://github.com/toland/qlmarkdown/releases/tag/v1.3.1, then using the Terminal, run the following from the Downloads directory:
 Install for all users
unzip QLMarkdown.qlgenerator.zip
sudo cp -r QLMarkdown.qlgenerator /Library/QuickLook/
qlmanage -r

If you prefer to install just for yourself, change the second line to:
cp -r QLMarkdown.qlgenerator ~/Library/QuickLook/

You can find more details here: https://github.com/toland/qlmarkdown/blob/v1.3.1/Readme.markdown.


Skip down to comments...
A quick disclaimer...

Although I put in a great effort into researching all the topics I cover, mistakes can happen. If you spot something out of place, please do let me know.

All content and opinions expressed on this Blog are my own and do not represent the opinions of my employer (Oracle). Use of any information contained in this blog post/article is subject to this disclaimer.
comments powered by Disqus
Other posts you may like...