using markdown for all your writing

I’m a big fan of markdown (md), and especially of Fletcher Penney’s branch multimarkdown (mmd). John Gruber invented the project to make it easier to write pieces destined for HTML, such as blog entries. md and its variants essentially provide a very light markup for plaintext that is transformed by the markdown engine into HTML. This post was written in mmd in textmate, and transformed/published using a python implementation of md. It’s so convenient that it has seriously taken off, at least in the Mac world, and most good text editors have md support baked in with syntax highlighting. But, it’s not just text editors (which you should be using to make your files anyway), as Scrivener has mmd support built in. And, enter lately a whole host of small and specialty apps for iOS and OSX systems. For example, I absolutely love Brett Terpstra’s fork of Notational Velocity, nValt, which includes several built-in mmd features including a preview pane for mmd-formatted notes, as well as browser plugins to import web pages directly into nValt transformed into md files.

Terpstra is also responsible for another of my favorite little apps, Marked. Marked is, essentially, a universal previewer and exporter for md and mmd files. The simple idea is this– if you’re working on a file, you can simultaneously open it in Marked to see a live preview of what it will look like converted into HTML. The power, though, is this– you can take that file and save it directly into not just HTML, but also to RTF or PDF. Moreover, using custom CSS, you can control directly what the output looks like, essentially giving yourself typographical control over your documents. I set up a custom CSS sheet that uses Adobe Garamond Pro (my absolute favorite font for academic writing output). So, now I can write anything I’m working on– be it a blog post, note-taking for research, transcriptions of my documents, letters of recommendation, my c.v., and even formal papers or chapters in my favorite text editor (textmate) using mmd and have easy export to RTF (if I need to share them with a Microsoft Word user) or PDF (if I don’t). Moreover, the files are simple plain text files, which are small and easy to version control. I can write, if I want, custom CSS for any task, and have real control over the PDF appearance of my documents without the complexity of writing LaTeX. And if need be, I can easily import into Scrivener for serious writing.1 And here’s a footnote on footnotes.2

Given the ability make footnotes, control headings, automatically produce a table of contents, and, with custom CSS, control typography, it’s hard to imagine what I can’t do with (multi)markdown as an academic with a whole variety of writing needs.


  1. Chad Black. The Limits of Gender Domination. University of New Mexico Press, 2010. 

  2. Footnotes and citations get automatically numbered. mmd also has the ability to make citations using BibTex styles, but that’s not included in python markdown, which I’m using for this post. 

About

Associate Professor of Early Latin America Department of History University of Tennessee-Knoxville

Tagged with: , , ,
Posted in Research and Writing
2 comments on “using markdown for all your writing
  1. […] state of my workflow, using bitbucket private repos to source control research materials, and on using markdown for all my writing […]

  2. How do you deal with citations in html exports?
    I found pandoc’s CSL approach to be fantastic, however, pandoc’s markdown does not handle figure nor table references.

    I feel like the markdown to html or latex approach to be a fantastic way of writing. However, the two main implementations are lacking in some small, but important ways.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

parecer:
parecer:

Hacer juicio ú dictamen acerca de alguna cosa... significando que el objeto excita el juicio ú dictamen en la persona que le hace.

Deducir ante el Juez la accion ú derecho que se tiene, ó las excepciones que excluyen la accion contrária.

RAE 1737 Academia autoridades
Buy my book!



Chad Black

About:
I, your humble contributor, am Chad Black. You can also find me on the web here.
%d bloggers like this: