Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 1.77 KB

README.md

File metadata and controls

39 lines (24 loc) · 1.77 KB

md2html

My humble tool for converting Markdown files to nicely formatted HTML files without fuss. These can be nicer to use and share than plain text.

Run it using

./md2html README.md

md2html will create a file called README.html.

Features

  • Easy-to-use commandline call. Can be used, e.g. in conjuction with a file monitor, a script, or a Quicksilver action.
  • One-file HTML output that displays on any computer.
  • Preserves the original Markdown source in the generated file.
  • Simple, pretty CSS. This is taken from toland's QLMarkdown, although most commits to the stylesheet seem to be by jiho. Most of it seems to based on ``ADC'', presumably the Apple Developer Connection. As required by the QLMarkdown license, credits are included at the bottom.

Dependencies

TODO

  • Compile the HTML file from the source portion in-place. This is a bit tricky because the file is commonly being edited at the same time. Some editors don't handle this well.

Use with Quicksilver

Create an Applescript file at "/Users/lgarron/Library/Application Support/Quicksilver/Actions/Markdown to HTML.scpt" with the code

on open theFile
	set the_file to POSIX path of theFile
	do shell script "[your path md2html] \"" & the_file & "\""
	return null
end open

Make sure that your reference tomarkdown in md2html does not depend on parts of the PATH that are only available in the commandline shell.

Credits

This product includes software developed by David Loren Parsons http://www.pell.portland.or.us/~orc