Convert Markdown Content to DITA in 20 seconds
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
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.
About Tom Johnson
I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, agent skills, tech comm careers, and more. Check out my AI courses for more on the latest in AI and tech comm. If you're looking for info about documenting APIs, see my API documentation course.
If you're a technical writer and want to keep on top of the latest trends in tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me.
Finally, I want to note a couple of things. I usually write the first drafts of my posts myself and then use AI to improve accuracy, clarity, and detail in places, so my writing is a mix of human and AI. (Hopefully that's not too off-putting.) Also, the opinions I express on my blog are my own perspectives, not those of my employer.