{"id":15600488,"url":"https://github.com/jason-fox/fox.jason.readthedocs","last_synced_at":"2025-03-29T12:23:08.275Z","repository":{"id":54682421,"uuid":"177466790","full_name":"jason-fox/fox.jason.readthedocs","owner":"jason-fox","description":"DITA-OT Plug-in which creates a set of output files suitable for a ReadTheDocs documentation project.","archived":false,"fork":false,"pushed_at":"2024-02-17T15:28:08.000Z","size":334,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-04T13:27:36.902Z","etag":null,"topics":["dita","dita-ot","dita-ot-plugin","readthdocs"],"latest_commit_sha":null,"homepage":"https://jason-fox.github.io/dita-ot-plugins/readthedocs","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/jason-fox.png","metadata":{"files":{"readme":"README.md","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,"publiccode":null,"codemeta":null}},"created_at":"2019-03-24T20:40:36.000Z","updated_at":"2022-11-15T10:01:08.000Z","dependencies_parsed_at":"2024-02-17T16:46:49.508Z","dependency_job_id":null,"html_url":"https://github.com/jason-fox/fox.jason.readthedocs","commit_stats":{"total_commits":90,"total_committers":3,"mean_commits":30.0,"dds":0.0888888888888889,"last_synced_commit":"0ff9679cedfe2c92f9a3224b293c1f1c267ba531"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jason-fox%2Ffox.jason.readthedocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jason-fox%2Ffox.jason.readthedocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jason-fox%2Ffox.jason.readthedocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jason-fox%2Ffox.jason.readthedocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jason-fox","download_url":"https://codeload.github.com/jason-fox/fox.jason.readthedocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246182269,"owners_count":20736728,"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":["dita","dita-ot","dita-ot-plugin","readthdocs"],"created_at":"2024-10-03T02:03:38.209Z","updated_at":"2025-03-29T12:23:08.256Z","avatar_url":"https://github.com/jason-fox.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ReadTheDocs Plugin for DITA-OT [\u003cimg src=\"https://jason-fox.github.io/fox.jason.readthedocs/readthedocs.png\" align=\"right\" width=\"300\"\u003e](https://readthedocsdita-ot.rtfd.io/)\n\n[![license](https://img.shields.io/github/license/jason-fox/fox.jason.readthedocs.svg)](http://www.apache.org/licenses/LICENSE-2.0)\n[![DITA-OT 4.0](https://img.shields.io/badge/DITA--OT-4.0-green.svg)](http://www.dita-ot.org/4.0)\n[![CI](https://github.com/jason-fox/fox.jason.readthedocs/workflows/CI/badge.svg)](https://github.com/jason-fox/fox.jason.readthedocs/actions?query=workflow%3ACI)\n[![Coverage Status](https://coveralls.io/repos/github/jason-fox/fox.jason.readthedocs/badge.svg?branch=master)](https://coveralls.io/github/jason-fox/fox.jason.readthedocs?branch=master)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fox.jason.readthedocs\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=fox.jason.readthedocs)\n\nThis is a [DITA-OT Plug-in](https://www.dita-ot.org/plugins) which creates a set of output files suitable to create a\n[ReadTheDocs](https://readthedocs.org) Documentation Project. The transform is an extension of the existing DITA-OT\nmarkdown plug-in (`org.lwdita`) and creates a well-formatted `mkdocs.yaml` file\n\n### Sample `mkdocs.yaml` File\n\n```yaml\nsite_name: \"ReadTheDocs Plug-in\"\n\npages:\n    - Home: index.md\n    - \"ReadTheDocs\":\n          - \"Examples\": \"topics/examples.md\"\n          - \"Full list of features\": \"topics/features-full.md\"\n          - \"Basic usage\": \"topics/basic-usage.md\"\n\ntheme: mkdocs\n```\n\n:arrow_forward: [Video from DITA-OT Day 2019](https://youtu.be/vobY_ha5nd0)\n\n[![](https://jason-fox.github.io/fox.jason.readthedocs/javascript-video.png)](https://youtu.be/vobY_ha5nd0)\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eTable of Contents\u003c/strong\u003e\u003c/summary\u003e\n\n-   [Install](#install)\n    -   [Installing DITA-OT](#installing-dita-ot)\n    -   [Installing the Plug-in](#installing-the-plug-in)\n-   [Usage](#usage)\n    -   [Creating a ReadtheDocs Project out of existing DITA content](#creating-a-readthedocs-project-out-of-existing-dita-content)\n    -   [Coverting a ReadtheDocs Project into DITA content](#coverting-a-readthedocs-into-dita)\n    -   [Parameter Reference](#parameter-reference)\n-   [Contribute](#contribute)\n-   [License](#license)\n\n\u003c/details\u003e\n\n## Install\n\nThe ReadTheDocs Plug-in for DITA-OT has been tested against [DITA-OT 4.x](http://www.dita-ot.org/download). It is\nrecommended that you upgrade to the latest version.\n\n### Installing DITA-OT\n\n\u003ca href=\"https://www.dita-ot.org\"\u003e\u003cimg src=\"https://www.dita-ot.org/images/dita-ot-logo.svg\" align=\"right\" width=\"55\" height=\"55\"\u003e\u003c/a\u003e\n\nThe ReadTheDocs Plug-in for DITA-OT is a plug-in for the DITA Open Toolkit.\n\n-   Full installation instructions for downloading DITA-OT can be found\n    [here](https://www.dita-ot.org/4.0/topics/installing-client.html).\n\n    1.  Download the `dita-ot-4.0.zip` package from the project website at\n        [dita-ot.org/download](https://www.dita-ot.org/download)\n    2.  Extract the contents of the package to the directory where you want to install DITA-OT.\n    3.  **Optional**: Add the absolute path for the `bin` directory to the _PATH_ system variable. This defines the\n        necessary environment variable to run the `dita` command from the command line.\n\n```console\ncurl -LO https://github.com/dita-ot/dita-ot/releases/download/4.0/dita-ot-4.0.zip\nunzip -q dita-ot-4.0.zip\nrm dita-ot-4.0.zip\n```\n\n### Installing the Plug-in\n\n-   Run the plug-in installation command:\n\n```console\ndita install https://github.com/jason-fox/fox.jason.readthedocs/archive/master.zip\n```\n\nThe `dita` command line tool requires no additional configuration.\n\n---\n\n## Usage\n\nLike any other transform, when invoked directly, the ReadTheDocs transforms require an input document\n\n### Creating a ReadtheDocs Project out of existing DITA content\n\nTo create the files for a ReadtheDocs project, use the `readthedocs` transform, set the `--input` parameter to point to\na `*.ditamap` file:\n\n```console\nPATH_TO_DITA_OT/bin/dita -f readthedocs -i document.ditamap\n```\n\n### Coverting a ReadtheDocs Project into DITA content\n\nTo create the files for a DITA-OT project, use the `mkdocs2dita` transform and set the `--input` parameter to point to a\n`mkdocs.yml` file:\n\n```console\nPATH_TO_DITA_OT/bin/dita -f mkdocs2dita -i mkdocs.yml\n```\n\n### Parameter Reference\n\n-   `args.css` - Specifies the name of a custom `.css` file. The css is added to the `mkdocs.yml` file as `extra_css`\n-   `args.csspath` - Specifies the location of a copied `.css` file relative to the output directory.\n-   `args.cssroot` - Specifies the directory that contains the custom `.css` file.\n-   `args.readthedocs.theme` - Specifies a `theme` to style the ReadTheDocs output (default: `readthedocs`)\n-   `args.readthedocs.template` - Specifies a template `mkdocs.yml` file to use - the template can hold additional\n    readthedocs attributes which are not generated by the transform.\n-   `args.readthedocs.use.pages` -  Specifies whether to use `pages` rather than `nav` (default `no`)\n\n## Contribute\n\nPRs accepted.\n\n## License\n\n[Apache 2.0](LICENSE) © 2019 - 2022 Jason Fox\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjason-fox%2Ffox.jason.readthedocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjason-fox%2Ffox.jason.readthedocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjason-fox%2Ffox.jason.readthedocs/lists"}