Lightweight DITA for DITA-OT
The DITA-OT LwDITA plug-in supersedes the previously released Markdown plug-in for DITA-OT and adds additional features to support Lightweight DITA.
Note: The LwDITA plug-in is included in DITA Open Toolkit 3.0 and newer.
- a custom parser for Markdown and HTML to allow using MDITA and HDITA as a source document format,
- and a transtype to generate Markdown from DITA source.
The Markdown DITA files need to use a subset of Markdown constructs for compatibility with DITA content models.
Using LwDITA files as input
Markdown DITA or HTML DITA topics can only be used by linking to them in map files.
<map> <topicref href="test.md" format="mdita"/> <topicref href="test.html" format="hdita"/> </map>
format attribute value must be set to
hdita in order to
recognize files as Markdown DITA or HTML DITA, respectively; the file extension is not used to
See Syntax reference for XML and Markdown DITA correspondence.
Generating Markdown output
The DITA-OT LwDITA plug-in extends the DITA Open Toolkit with additional output formats (transformation types) that can be used to publish DITA content as Markdown.
To publish Markdown DITA files, use the
To generate GitHub Flavored Markdown files, use the
To publish GitHub Flavored Markdown and generate a
SUMMARY.mdtable of contents file for publication via GitBook, use the
DITA-OT 2.2 is required. Earlier versions of DITA-OT do not have the required extension points.
Run the plug-in installation command:
dita -install https://github.com/jelovirt/org.lwdita/releases/download/2.0.6/org.lwdita-2.0.6.zip
dita command line tool requires no additional configuration;
running DITA-OT using Ant requires adding plug-in contributed JAR files
CLASSPATH with e.g.
To build the DITA-OT Markdown plug-in from source:
Install the DITA-OT distribution JAR file dependencies by running
gradle installfrom your clone of the DITA-OT repository. The required dependencies are installed to a local Maven repository in your home directory under
Run the Gradle distribution task to generate the plug-in distribution package:
The distribution ZIP file is generated under
DITA-OT LwDITA is licensed for use under the Apache License 2.0.