MDITA

MDITA is the authoring format of LwDITA that uses Markdown to structure information.

LwDITA includes two profiles for authoring MDITA topics:

Core profile

Aligns with the GitHub Flavored Markdown spec and includes markup common to most Markdown flavors.

Extended profile

Relies upon features only available in specific flavors of Markdown to enable a more consistent DITA-like experience.

MDITA is designed for users who want to write structured content with the minimum of overhead, but who also want to take advantage of the reuse mechanisms associated with the DITA standard and the multi-channel publishing afforded by standard DITA tooling.

Potential users of the MDITA core profile include the following:

  • Software developers who want to contribute to DITA-based product documentation without using an XML editor

  • Software developers who want to contribute to product documentation using the tools and markup of their choice

  • Developers and writers in charge of documenting application programming interfaces (APIs) that need to share content with technical publications

  • Individuals authoring content using a platform, such as a mobile device, that does not support an XML editor

  • Individuals authoring content quickly that must be later refactored as structured content

  • Non-English-speaking authors who want to take advantage of DITA reuse and publishing without depending on XML tags written in English

Potential users of the MDITA extended profile include the following:

  • Content curators who receive occasional contributions from developers written in Markdown

  • Technical editors who need to incorporate Markdown files in DITA or XDITA topic collections

  • Content developers familiar with DITA or XDITA who want to use Markdown as an authoring language on devices that do not support XML editors