/registry

DITA Open Toolkit plug-in registry

Primary LanguageJavaScriptApache License 2.0Apache-2.0

DITA Open Toolkit Plug-in Registry Netlify Status

This repository serves as the data backend for the DITA-OT plug-in registry.

The registry provides a searchable list of plug-ins at dita-ot.org/plugins, which makes it easier to discover and install new plug-ins for DITA Open Toolkit.


DITA-OT plug-in registry


Adding plug-ins to the registry

The entries for each plug-in are stored in a file named after the plug-in ID as <plugin-name>.json.

To add a plug-in, fork this repository, create a new plug-in entry file in JSON format, and send a pull request.

For details on the file format, see Publishing plug-ins to the registry in the DITA-OT documentation.

Contribution Guidelines

This repository follows the DITA-OT Contribution Guidelines, summarized below:

  • If you find a bug or would like to suggest a change, create an issue.
    (If it's a bug, provide steps to recreate the issue.)

  • To add a new plug-in or new version, submit a pull request with the proposed changes. Create separate pull request for each plug-in version.

  • Indicate that you agree to the terms of the Apache License Version 2.0 by "signing off" your contribution with git commit -s.

    This adds a line with your name and e-mail address to your Git commit message:

     Signed-off-by: Jane Doe <jane.doe@example.com>