{"id":14447153,"url":"https://github.com/dita-ot/docs","last_synced_at":"2026-01-02T18:51:00.545Z","repository":{"id":23491000,"uuid":"26856261","full_name":"dita-ot/docs","owner":"dita-ot","description":"DITA Open Toolkit documentation","archived":false,"fork":false,"pushed_at":"2024-09-01T10:37:12.000Z","size":8809,"stargazers_count":57,"open_issues_count":16,"forks_count":95,"subscribers_count":20,"default_branch":"develop","last_synced_at":"2024-09-02T07:03:03.959Z","etag":null,"topics":["ant","dita","dita-ot","documentation","documentation-tool","hacktoberfest","publishing","xml","xslt"],"latest_commit_sha":null,"homepage":"https://www.dita-ot.org/dev","language":"XSLT","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.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.md","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,"publiccode":null,"codemeta":null}},"created_at":"2014-11-19T10:28:36.000Z","updated_at":"2024-08-23T15:01:06.000Z","dependencies_parsed_at":"2023-12-21T15:58:30.863Z","dependency_job_id":"a17c0741-6ded-4be4-9762-0ca86c438466","html_url":"https://github.com/dita-ot/docs","commit_stats":null,"previous_names":[],"tags_count":69,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dita-ot%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dita-ot%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dita-ot%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dita-ot%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dita-ot","download_url":"https://codeload.github.com/dita-ot/docs/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243963944,"owners_count":20375687,"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","documentation-tool","hacktoberfest","publishing","xml","xslt"],"created_at":"2024-09-01T07:01:18.818Z","updated_at":"2026-01-02T18:51:00.539Z","avatar_url":"https://github.com/dita-ot.png","language":"XSLT","funding_links":[],"categories":["Authoring formats"],"sub_categories":["DITA"],"readme":"# DITA Open Toolkit Docs [![Build Status][1]](https://github.com/dita-ot/docs/actions/workflows/deploy.yml) [![DITA-OT Discussions][2]](https://github.com/orgs/dita-ot/discussions)\n\nThis repository tracks the [documentation][3] source files for the [DITA Open Toolkit project][4].\n\n\u003c!-- MarkdownTOC levels=\"2\" --\u003e\n\n- [Building the documentation output](#building-the-documentation-output)\n- [Building with development versions of DITA Open Toolkit](#building-with-development-versions-of-dita-open-toolkit)\n- [Contribution guidelines](#contribution-guidelines)\n- [Installing formatting tools](#installing-formatting-tools)\n- [Running Prettier](#running-prettier)\n\n\u003c!-- /MarkdownTOC --\u003e\n\n## Building the documentation output\n\n\u003e **Note**\n\u003e\n\u003e The maps in this repository contain references to additional topics that are created at build time from the toolkit’s plug-in configuration.\n\u003e\n\u003e To generate the missing topics and build the HTML and PDF versions of the documentation, run the Gradle build script from the root level of the `docs` repository and pass the path to your DITA-OT installation as a parameter.\n\n### Prerequisites\n\nYou must have a JRE and a local installation of DITA-OT. There is no need to download and install Gradle.\n\n### Steps\n\n1.  Open a command prompt, and change to the directory of your docs repository clone.\n2.  Type a variant of the following command for your operating system, adjust the path to your DITA-OT installation, and press \u003ckbd\u003eEnter\u003c/kbd\u003e:\n    - On **Linux**, **macOS**, or **Git Bash**, use `./gradlew`:\n\n          ./gradlew -PditaHome=/path/to/dita-ot\n\n    - On **Windows**, use `gradlew.bat`:\n\n          gradlew.bat -PditaHome=C:\\path\\to\\dita-ot\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eAlternative:\u003c/strong\u003e Using a DITA-OT repository clone\u003c/summary\u003e\n\nIf you’re using a clone of the [DITA-OT development repository][5] as your toolkit installation alongside your clone of the `docs` repository:\n\n1.  In the root directory of your `dita-ot` repository, run Gradle to compile the Java code and install plugins.\n    - On **Linux**, **macOS**, or **Git Bash**, use `./gradlew`.\n    - On **Windows**, use `gradlew.bat`.\n\n2.  Then run the Gradle build in the `docs` repository to generate topics and build the documentation output.\n    - On **Linux**, **macOS**, or **Git Bash**, run the build script like this:\n\n          ./gradlew -PditaHome=../dita-ot/src/main\n\n    - On **Windows**, use `gradlew.bat`:\n\n          gradlew.bat -PditaHome=C:\\path\\to\\dita-ot\\src\\main\n\n\u003c/details\u003e\n\nYou can also specify a single output format. To build HTML for example, add `html` to the end of the command:\n\n    ./gradlew -PditaHome=/path/to/dita-ot html\n\n### Results\n\nIf all goes well, you receive a \"BUILD SUCCESSFUL\" message, and the generated DITA topics are written to the `extension-points` and `parameters` directories in the `out` folder of the `docs` repository.\n\nThis folder is created automatically if it doesn’t exist. _(Git ignores the contents so you don’t inadvertently commit these transient output files.)_\n\n## Building with development versions of DITA Open Toolkit\n\nThe `develop` branch of the documentation repository may depend on features from recent development versions of DITA Open Toolkit.\n\nTo use these features when building the documentation, you may either download the [latest development version][6] of the distribution package, or clone the [DITA-OT repository][5] and install the [bundled plug-ins][7] via `dita install`.\n\n## Contribution guidelines\n\nWe welcome contributions to the DITA-OT documentation. Please review the [guidelines for contributing][8] to this repository before creating issues or opening pull requests.\n\nFor best results, follow the [coding guidelines][9] and [best practices][10] outlined in the docs project wiki:\n\n- [Test before committing][11]\n- [Commit related changes][12]\n- [Commit often][13]\n- [Write good commit messages][14]\n- [Sign your work][15]\n\n## Installing formatting tools\n\nThe documentation repository uses the following JavaScript tools to keep source files consistently formatted:\n\n- [Prettier][16] is an opinionated code formatter that enforces a consistent style by parsing code and re-printing it.\n- [Husky][17] uses Git hooks to ensure that Prettier runs on all staged changes to format files before committing.\n\n### Prerequisites\n\n- You must have a stand-alone installation of Git from [git-scm.com/downloads][18].\n- Include the Git installation location in the [`PATH`][19] environment variable.\n\n### Steps\n\nTo set these tools up:\n\n1. Install Node.js® from [nodejs.org][20]\n2. Open a command prompt, and change to the directory of your docs repository clone.\n3. Run `npm install`\n\nWith these tools in place, any changes you make to the documentation source files will be automatically formatted when you commit them with Git. This ensures that commits contain only related changes, and no extra formatting.\n\n\u003cdetails\u003e\n\u003csummary\u003eTroubleshooting\u003c/summary\u003e\n\nIf the `git` command is not available in your command-line environment, the Husky installation may fail with an error message:\n\n    \"Cannot read property 'toString' of null\"\n\n_Solution:_ Uninstall Husky via `npm husky uninstall`. Install [Git][18]. Add the installation location to the [`PATH`][19] environment variable. Re-run `npm install`.\n\n\u003c/details\u003e\n\n## Running Prettier\n\nIf you'd like to check whether your changes are formatted correctly, or format them before committing, you can run Prettier manually from the command line.\n\n### Check formatting\n\n    npm run check\n\n### Format all files\n\n    npm run format\n\n[1]: https://github.com/dita-ot/docs/actions/workflows/deploy.yml/badge.svg\n[2]: https://img.shields.io/github/discussions/dita-ot/dita-ot?label=DITA-OT%20Discussions\n[3]: https://www.dita-ot.org/dev/\n[4]: https://www.dita-ot.org\n[5]: https://github.com/dita-ot/dita-ot\n[6]: https://s3-eu-west-1.amazonaws.com/dita-ot/dita-ot-develop.zip\n[7]: https://github.com/dita-ot/dita-ot/blob/develop/build.gradle#L247-L259\n[8]: .github/CONTRIBUTING.md\n[9]: https://github.com/dita-ot/docs/wiki/Coding-guidelines\n[10]: https://github.com/dita-ot/docs/wiki/Git-workflow#best-practices\n[11]: https://github.com/dita-ot/docs/wiki/Git-workflow#test-before-committing\n[12]: https://github.com/dita-ot/docs/wiki/Git-workflow#commit-related-changes\n[13]: https://github.com/dita-ot/docs/wiki/Git-workflow#commit-often\n[14]: https://github.com/dita-ot/docs/wiki/Git-workflow#writing-good-commit-messages\n[15]: https://www.dita-ot.org/DCO\n[16]: https://prettier.io\n[17]: https://github.com/typicode/husky\n[18]: https://git-scm.com/downloads\n[19]: https://en.wikipedia.org/wiki/PATH_(variable)\n[20]: https://nodejs.org\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdita-ot%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdita-ot%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdita-ot%2Fdocs/lists"}