Improve your web writing by getting back to basics with MultiMarkdown

March 24, 2010 · 8 comments

I recently discovered a great new tool for web writers called MultiMarkdown thanks to a recent Mac Power Users podcast.

Now on first glance, you’ll probably think that this is too nerdy/geeky for the common person, but it’s actually a gift to anyone who’s been troubled by the fact that it’s so darn hard to convert anything to clean HTML. If you’ve never had that thought, or never had the need to convert a document to HTML, you can safely move on. If you have, read on…

If you’re a blogger, you’ve probably experimented with different ways of composing your blog posts. Perhaps you’ve tried word processors like Microsoft Word or other desktop apps because you don’t like editing in a browser (like me). Writing in these apps works fine (assuming you aren’t distracted by the superfluous amount of commands bordering your page), but for all the technology and ubiquity of the Web,  converting your composition to something that can be rendered on a web page is still a royal pain.

Microsoft Word, for example, is designed to generate an inordinate amount of additional HTML coding around even the simplest of HTML documents. There was probably less code running the Apollo space craft than is contained in a Word-generated HTML file. And of course, once pasted into your blog editor of choice, it never looks the same as it did in Word.

Maybe you’ve also tried composing in a simple text editor like TextEdit on your Mac or even Notepad on your PC. Again, the writing part is easy, but now you’re stuck having to type long HTML commands like anchors, breaks, paragraph codes, etc. over and over. And if you need to create a table, just forget it.

The underlying problem is that you find yourself playing the role of a programmer at least as much as a writer. This can be a major distraction that ultimately affects the quality of your work.

MutltiMarkdown eases the woe of the common web writer by providing simple, intuitive shortcuts for HTML codes. For example, a table can be created simply using the pipe symbol like this:

|col 1|col 2|
|--|--|
|abc|def|

The above bit of code turns into

col 1 col 2
abc def

I really like the way MutltiMarkdown handles links too. There are several different ways of typing a link. The simplest is like this:

[Google](http://www.google.com)

If you have long URLs, you may want to use this footnote-like method:

[Google][1]
[1]: http://www.google.com

The second alternative above has the advantage of keeping your text even cleaner, so you don’t have long URLs cluttering up your paragraphs. You can put the hyperlink number anywhere in your file (I like putting them in a stack at the bottom.)

Both methods generate the same result: Google.

So in summary, with MultiMarkdown, you can focus on your writing, not your coding. When you’re done drafting, you simply convert your text file to HTML using a script provided on the MultiMarkdown website.

If you’re a Mac user, you’re in even more luck. Fletcher Penney, the author of MultiMarkdown, created several apps that let you simply drag and drop your MultiMarkdown text file to create HTML, RTF, and other formats.

Even better, there are a number of Mac apps that are compatible with MultiMarkdown like Scrivener, OmniOutliner, and Notational Velocity.

In summary, if you use MultiMarkdown to write your HTML-bound documents, you can

  1. Write in a simple text editor using the MultiMarkdown syntax.
  2. Save the file like file.txt (or whatever file name you prefer).
  3. Drag the text file to one of the apps that automatically translates the MultiMarkdown format into HTML.
  4. Copy your HTML to your favorite blog editor (or wherever you want it).

Let me know if you have any questions on MultiMarkdown or how you’re using it in the comments.

Also, be sure to check out the original Markdown page and PHP Markdown Extra for extra syntax tips.

{ 6 comments }

Dean October 5, 2010 at 5:18 am

This is a pretty old post, but some may end up coming across this in their searches regarding Markdown (or MultiMarkdown like I did, so I thought I would share this little bit of information with you:

Generally speaking, at least for the base of Markdown (the part that John Gruber created) you can pretty easily find a plugin for your blogging platform of choice that will make the platform accept Markdown, and convert it for you. I know for a fact that there are a number of Wordpress plugins, and it’s possible with TextPattern with a little bit of tweaking.

Eddie October 5, 2010 at 6:50 am

Thanks for throwing that out there, Dean. I actually have not looked into any Markdown WordPress plugins. I usually do the conversion using a Hazel workflow that I wrote up after this post. I can see the merit of skipping that and letting a WordPress plugin take care of things when just want to go directly to WordPress. I will check that out.

Simon November 26, 2010 at 7:13 am

I’ve noticed textmate can convert multi/markdown on the fly. Initially I thought this was good until I realised I needed to reuse some of my documents. Having them then saved in HTML was a problem. I needed them back in mmd. I’ve decided to save them in mmd. The question then is do I go the whole hog and use a markdown convertor for my Wordpress site and save the conversion hassle. It’s not a major hassle, but if my workflow can be reduced so much the better.

My concern with plugins are the continued support. If you write a 1000 articles on your blog in mmd and an upgrade breaks your mmd plugin, your whole site goes down.

What do you think?

Eddie November 28, 2010 at 7:22 pm

I agree. Personally, I prefer to leave a copy of everything I write in plain text with the Markdown syntax intact. Like you, I’m not super trustful of plugins that display Markdown as HTML. It seems like a good way to invite problems down the road.

As far as converting Markdown / MultiMarkdown to HTML, there are so many ways. One workflow that I still use quite a bit is described here:

http://www.practicallyefficient.com/2010/05/19/my-multimarkdown-writing-workflow-with-launchbar-and-hazel/

These days, I do almost all of my Markdown writing in Notational Velocity. I’ve written about NV a good bit around here. You might want to do a search for that term if you’re interested in learning more.

Simon November 29, 2010 at 4:13 pm

Does NV display Multimarkdown? The only thing I’ve found that gives me proper preview of my mmd text is Marsedit. I quite like fletcher penny’s theme for markdown in textmate as it displays the text in the editor according to format. As I haven’t done a huge amount of stuff in mmd, I’m always on the lookout for a good previewer.

Eddie November 29, 2010 at 4:46 pm

Simon, You might want to check out this post, which has links to a version of NV that not only converts MMD to HTML in a preview window, it also lets you save an MMD file as HTML:

http://www.practicallyefficient.com/2010/10/25/notational-velocity-save-as-html/

Comments on this entry are closed.

{ 2 trackbacks }

Previous post:

Next post: