Sponsored content

Search results

Convert Markdown Content to DITA in 20 seconds

by Tom Johnson on Dec 3, 2014 •
categories: technical-writing

A while ago I posted some thoughts on converting Markdown to DITA. I refined this conversion process using the Multimarkdown script and OxygenXML. Here's a demo:

(There's no audio to this 20 second video -- it just loops over and over.)

I added more details on how to configure this in my DITA QRG: Author in Markdown, Publish with DITA.

Sponsored content

Why would you want to convert from Markdown to DITA? Mainly, you would use this script in the content development stages of a project. As you're gathering information, finding out details, adding and removing steps from lists, and otherwise developing your information, you need a quick way to author and shape content. Markdown offers this quick syntax for creating content.

Once you get to a point where you want to start working with the XML, such as re-using notes or adding specific attributes to different elements, convert it all to DITA and work with it there.

Note that you can't create DITA specific elements in Markdown, such as notes. But you can author a lot of elements that do carry over.

Buy me a coffeeBuy me a coffee
follow us in feedly

About Tom Johnson

Tom Johnson

I'm a technical writer / API doc specialist based in the Seattle area. In this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, visual communication, information architecture, writing techniques, plain language, tech comm careers, and more. Check out simplifying complexity and API documentation for some deep dives into these topics. If you're a technical writer and want to keep on top of the latest trends in the field, be sure to subscribe to email updates. You can also learn more about me or contact me.