{"id":13689537,"url":"https://github.com/dita-ot/dita-ot","last_synced_at":"2025-04-12T22:36:25.812Z","repository":{"id":3004039,"uuid":"4022719","full_name":"dita-ot/dita-ot","owner":"dita-ot","description":"DITA Open Toolkit — the open-source publishing engine for content authored in the Darwin Information Typing Architecture.","archived":false,"fork":false,"pushed_at":"2024-03-26T10:46:37.000Z","size":103532,"stargazers_count":379,"open_issues_count":285,"forks_count":192,"subscribers_count":82,"default_branch":"develop","last_synced_at":"2024-03-26T11:00:32.444Z","etag":null,"topics":["ant","dita","dita-ot","documentation-tool","hacktoberfest","publishing","xml","xslt"],"latest_commit_sha":null,"homepage":"https://www.dita-ot.org","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dita-ot.png","metadata":{"files":{"readme":"README.markdown","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2012-04-14T04:49:04.000Z","updated_at":"2024-04-05T06:26:25.396Z","dependencies_parsed_at":"2023-10-12T00:03:25.984Z","dependency_job_id":"f94f1894-bd0f-4020-8195-ef003e81fb88","html_url":"https://github.com/dita-ot/dita-ot","commit_stats":{"total_commits":5259,"total_committers":82,"mean_commits":64.13414634146342,"dds":0.3261076250237688,"last_synced_commit":"3d4015538e829e0de8b38c40ee2bd790d9cbd964"},"previous_names":[],"tags_count":139,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dita-ot%2Fdita-ot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dita-ot%2Fdita-ot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dita-ot%2Fdita-ot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dita-ot%2Fdita-ot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dita-ot","download_url":"https://codeload.github.com/dita-ot/dita-ot/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248642827,"owners_count":21138352,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ant","dita","dita-ot","documentation-tool","hacktoberfest","publishing","xml","xslt"],"created_at":"2024-08-02T15:01:51.675Z","updated_at":"2025-04-12T22:36:25.794Z","avatar_url":"https://github.com/dita-ot.png","language":"Java","funding_links":[],"categories":["hacktoberfest"],"sub_categories":[],"readme":"# DITA Open Toolkit [![DITA-OT Discussions][discussions]](https://github.com/orgs/dita-ot/discussions)\n\n_DITA Open Toolkit_, or _DITA-OT_ for short, is an open-source publishing engine for content authored in the _Darwin Information Typing Architecture_.\n\nVisit the project website at [dita-ot.org][site] for documentation, information about releases, and [download packages][dist].\n\nFor information on additional DITA and DITA-OT resources, see [SUPPORT]. To report a bug or suggest a feature, [create an issue][issue]. For more information on how you can help contribute to the project, see [CONTRIBUTING].\n\n- [Prerequisites: Java 17](#prerequisites-java-17)\n- [Installing](#installing)\n- [Building output](#building-output)\n- [Development](#development)\n    - [Running tests](#running-tests)\n    - [Formatting code](#formatting-code)\n    - [Distribution builds](#distribution-builds)\n- [License](#license)\n\n## Prerequisites: Java 17\n\nTo build and run DITA-OT, you’ll need Java Development Kit (JDK), version 17 or newer.\n\nYou can download the OpenJDK from [AdoptOpenJDK][adoptopenjdk].\n\n## Installing\n\n1.  Download the distribution package from [dita-ot.org/download][dist].\n2.  Extract the contents of the package to the directory where you want to install DITA-OT.\n\n\u003cdetails\u003e\n\u003csummary\u003eInstalling via Homebrew\u003c/summary\u003e\n\nOn macOS and Linux, you can also install DITA-OT using the [Homebrew] package manager:\n\n```shell\nbrew install dita-ot\n```\n\nHomebrew will automatically download the latest version of the toolkit, install it in a subfolder of the local package Cellar and symlink the `dita` command to the `bin` subfolder of the Homebrew installation directory.\n\n\u003e **Note**\n\u003e\n\u003e Homebrew’s default installation location depends on the operating system architecture:\n\u003e\n\u003e - `/usr/local` on macOS Intel\n\u003e - `/opt/homebrew` on macOS ARM\n\u003e - `/home/linuxbrew/.linuxbrew` on Linux\n\n\u003c/details\u003e\n\n## Building output\n\nYou can generate output using the `dita` command-line tool included with DITA Open Toolkit.\n\n1.  On the command line, change to the `bin` folder of the DITA-OT installation directory:\n    ```shell\n    cd path/to/dita-ot-dir/bin\n    ```\n2.  Run the `dita` command to generate output:\n\n    ```shell\n    dita --input=input-file --format=format [options]\n    ```\n\n    where:\n\n    - _`input-file`_ is the DITA map or DITA file that you want to process\n    - _`format`_ is the output format (or “transformation type”)\n\nSee the [documentation][docs] for arguments and [options].\n\n## Development\n\nBuilding the toolkit from source code and compiling the distribution package\n\n1.  Clone the DITA-OT Git repository, including submodules:\n    ```shell\n    git clone --recurse-submodules git://github.com/dita-ot/dita-ot.git\n    ```\n2.  Change to the DITA-OT directory:\n    ```shell\n    cd dita-ot\n    ```\n3.  In the root directory, run Gradle to compile the Java code and install plugins:\n    ```shell\n    ./gradlew\n    ```\n\n### Running tests\n\n```shell\n./gradlew check\n```\n\nAll tests are run by GitHub Actions [test workflow] on each push and\nfor every pull request. \n\n### Formatting code\n\nRequirements:\n\n- Node.js\n\nPrettier is used retain consistent Java formatting.\n\n1.  Run Prettier:\n    ```shell\n    npm run fmt\n    ```\n\n### Distribution builds\n\n1.  In the root directory, set up the build environment:\n    ```shell\n    ./gradlew\n    ```\n2.  Build the distribution packages:\n\n    ```shell\n    ./gradlew dist\n    ```\n\n    Distribution packages are built in the `build/distributions` directory.\n\n    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`.\n\n    For more information on the `-Xmx` option, see the [Java SE Documentation][javadoc].\n\n## License\n\nDITA Open Toolkit is licensed for use under the [Apache License 2.0][apache].\n\n[discussions]: https://img.shields.io/github/discussions/dita-ot/dita-ot?label=DITA-OT%20Discussions\n[site]: https://www.dita-ot.org/\n[dist]: https://www.dita-ot.org/download\n[support]: https://github.com/dita-ot/.github/blob/master/SUPPORT.md\n[adoptopenjdk]: https://adoptopenjdk.net/\n[homebrew]: https://brew.sh\n[docs]: https://www.dita-ot.org/dev/\n[options]: https://www.dita-ot.org/dev/topics/build-using-dita-command.html\n[javadoc]: http://docs.oracle.com/javase/8/docs/technotes/tools/windows/java.html#BABHDABI\n[apache]: http://www.apache.org/licenses/LICENSE-2.0\n[issue]: https://github.com/dita-ot/dita-ot/issues/new/choose\n[contributing]: https://github.com/dita-ot/.github/blob/master/CONTRIBUTING.md\n[test workflow]: https://github.com/dita-ot/dita-ot/actions/workflows/test.yml","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdita-ot%2Fdita-ot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdita-ot%2Fdita-ot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdita-ot%2Fdita-ot/lists"}