Skip to content

Commit

Permalink
adding separate readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ttscoff committed Mar 19, 2012
1 parent 6893f23 commit 891697e
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
### MultiMarkdown Quick Look with Style

<https://github.com/ttscoff/MMD-QuickLook>

[mmdql]: https://github.com/fletcher/MMD-QuickLook

This is a quick fork of Fletcher Penney's [MMD Quicklook project][mmdql]. It adds some styling to the default Quick Look preview (based on GitHub CSS) and allows for customization via a `.mdqlstyle.css` file in your home folder.

To install, place the `MultiMarkdown QuickLook.qlgenerator` file in `~/Library/QuickLook/`. To make sure the Quick Look generator list reloads with the new file, you can run `qlmanage -r` on the command line.

To use a custom style, name the CSS file `.mdqlstyle.css` and place it in your User's home directory. Note the leading period. Default padding for the body class will be included before your styles, so you can pretty much drop in any CSS you want from any source. Use one of the provided files, copy CSS from your blog, your favorite website or build your own.

### Ready-made styles

A couple of default styles lifted from [Marked.app][marked].

* [Swiss](https://raw.github.com/ttscoff/MMD-QuickLook/master/mdqlstyle.swiss.css)
* [Upstanding Citizen](https://raw.github.com/ttscoff/MMD-QuickLook/master/mdqlstyle.upstandingcitizen.css) (includes custom fonts embedded in the CSS as data URIs)

[marked]: http://markedapp.com

0 comments on commit 891697e

Please sign in to comment.