This project provides you with a template that uses Oxygen Scripting to generate HTML documentation for your schema files from a GitHub repository. It works with XML Schema (XSD), XSL, WSDL, JSON Schema and OpenAPI files.
To get things ready, follow these steps:
- Create a new GitHub project using this template. This allows you to easily create a new repository without copying and pasting the content, and with no history or reference to this repository. All you have to do is click the Use this template button. Make sure to check Include all branches option.
- Get an Oxygen Scripting license key from https://www.oxygenxml.com/xml_scripting/pricing.html (you can also request a trial). Add it as a secret to your repository (Settings → Secrets and variables → Actions → New repository secret), and name it "SCRIPTING_LICENSE_KEY".
Now, as the setup should be ready, you can add the schema files that you want to document to the schemas directory. Feel free to use or remove the sample files provided with this template. To run the documentation script, follow these steps:
- In your GitHub repository, click on Actions tab.
- Select Run Documentation Script from the left panel.
- Click the Run workflow button in the right side.
- Type the name of the schema to document (e.g. personal.xsd).
- Click Run workflow.
📝 The generated documentation files will be deployed to gh-pages branch. Make sure the workflow has read/write permissions (Settings → Actions → General → Workflow permissions). Otherwise, you may not be able to deploy your documentation.
👀 If you already have your schema files on a repository, you may want to check Oxygen Documentation action and include it in your workflow.
The main documentation file generated using Oxygen Scripting should be available here: https://{userid}.github.io/{reponame}/{schemaName}.html
The main documentation file generated from personal.xsd file from oxygenxml repository is available here: https://oxygenxml.github.io/oxygen-script-documentation-template/personal.html