Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dita-ot/registry

DITA Open Toolkit plug-in registry
https://github.com/dita-ot/registry

dita dita-ot dita-ot-html-plugin dita-ot-pdf-plugin dita-ot-plugin hacktoberfest publishing xml

Last synced: about 2 months ago
JSON representation

DITA Open Toolkit plug-in registry

Awesome Lists containing this project

README

        

# DITA Open Toolkit Plug-in Registry [![Netlify Status](https://api.netlify.com/api/v1/badges/626192a4-0b63-4a52-9b5a-ef6b46dc6464/deploy-status)](https://app.netlify.com/sites/plugins-dita-ot/deploys)

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](https://www.dita-ot.org/plugins), which makes it easier to discover and install new plug-ins for DITA Open Toolkit.

- [Adding plug-ins to the registry](#adding-plug-ins-to-the-registry)
- [Contribution Guidelines](#contribution-guidelines)

---

![DITA-OT plug-in registry](https://user-images.githubusercontent.com/129995/48142257-bee91a00-e2ac-11e8-877e-827d2471fec6.png)

---

## Adding plug-ins to the registry

The entries for each plug-in are stored in a file named after the plug-in ID as `.json`.

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

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

## Contribution Guidelines

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

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

- To add a new plug-in or new version, [submit a pull request][2] 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][6]" your contribution with `git commit -s`.

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

```bash
Signed-off-by: Jane Doe
```

[1]: https://help.github.com/articles/fork-a-repo/
[2]: https://help.github.com/articles/about-pull-requests/
[3]: https://www.dita-ot.org/dev/topics/plugins-registry.html#plugin-registry__publishing-to-registry
[4]: https://github.com/dita-ot/dita-ot/blob/develop/.github/CONTRIBUTING.md
[5]: https://github.com/dita-ot/registry/issues/new
[6]: https://www.dita-ot.org/DCO