DITA Open Toolkit, or DITA-OT for short, is an open-source publishing engine for content authored in the Darwin Information Typing Architecture.
Visit the project website at dita-ot.org for documentation, information about releases, and download packages.
For information on additional DITA and DITA-OT resources, see SUPPORT. To report a bug or suggest a feature, create an issue. For more information on how you can help contribute to the project, see CONTRIBUTING.
To build and run DITA-OT, you’ll need Java Development Kit (JDK), version 17 or newer.
You can download the OpenJDK from AdoptOpenJDK.
You can generate output using the dita
command-line tool included with DITA Open Toolkit.
bin
folder of the DITA-OT installation directory:
cd path/to/dita-ot-dir/bin
Run the dita
command to generate output:
dita --input=input-file --format=format [options]
where:
input-file
is the DITA map or DITA file that you want to processformat
is the output format (or “transformation type”)See the documentation for arguments and options.
Building the toolkit from source code and compiling the distribution package
git clone --recurse-submodules git://github.com/dita-ot/dita-ot.git
cd dita-ot
./gradlew
./gradlew check
All tests are run by GitHub Actions test workflow on each push and for every pull request.
Requirements:
Prettier is used retain consistent Java formatting.
npm run fmt
./gradlew
Build the distribution packages:
./gradlew dist
Distribution packages are built in the build/distributions
directory.
If Gradle throws an error like java.lang.OutOfMemoryError: Java heap space
, you probably need to increase the maximum Java heap size. One way to do this is to set the GRADLE_OPTS
environment variable to a value like -Xmx1024m
.
For more information on the -Xmx
option, see the Java SE Documentation.
DITA Open Toolkit is licensed for use under the Apache License 2.0.