Skip to content

Commit

Permalink
add README
Browse files Browse the repository at this point in the history
  • Loading branch information
fletcher committed Oct 12, 2011
1 parent eb31d58 commit 2851fff
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions Readme.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# MultiMarkdown QuickLook Plugin #

## Introduction ##

This is a complete rewrite of the MultiMarkdown version of Phil Toland's QLMarkdown plugin. The MMD version caused multiple copies of the `multimarkdown` process to spawn and run the CPU usage to 100%. I'm sure it was something I did, and not a problem with qlmarkdown.

But in order to fix it, it just made more sense to start over.

This program allows you to preview a MultiMarkdown text file (or OPML file) in the Finder after converting it to HTML with MMD.

## Installation ##

To install, simply put the "MultiMarkdown QuickLook" file in:

~/Library/QuickLook

To uninstall, simply remove it.

This version of the QuickLook plugin includes an embedded copy of MultiMarkdown 3.2, as well as `opml2mmd.xslt`. So there's nothing else to install to get it to work. The version of mmd that's embedded should run on any Intel Mac.


Downloads
---------

Source code is available at <http://github.com/fletcher/MMD-QuickLook>.

You can download a binary release from <https://github.com/fletcher/MMD-QuickLook/downloads>.


License
-------

The QLMarkdown code is distributed under the same terms as [peg-multimarkdown].

Known Issues
------------

Images are not displayed in previews.


Version History
---------------

[peg-multimarkdown]: https://github.com/fletcher/peg-multimarkdown

0 comments on commit 2851fff

Please sign in to comment.