https://github.com/infotexture/ot-mkdocs-demo
Markdown export of the DITA Open Toolkit documentation and sample MkDocs output
https://github.com/infotexture/ot-mkdocs-demo
dita dita-ot mkdocs mkdocs-material mkdocs-site
Last synced: 2 months ago
JSON representation
Markdown export of the DITA Open Toolkit documentation and sample MkDocs output
- Host: GitHub
- URL: https://github.com/infotexture/ot-mkdocs-demo
- Owner: infotexture
- Created: 2023-03-25T18:41:33.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-12-20T14:35:51.000Z (over 1 year ago)
- Last Synced: 2025-03-02T20:44:45.504Z (2 months ago)
- Topics: dita, dita-ot, mkdocs, mkdocs-material, mkdocs-site
- Homepage: https://infotexture.github.io/ot-mkdocs-demo/
- Size: 1.57 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: ReadMe.md
Awesome Lists containing this project
README
# DITA Open Toolkit Docs — MkDocs Demo
This repository includes a snapshot of the [DITA Open Toolkit][1] documentation in [Markdown][2] format.
The output was generated using the [Lightweight DITA plug-in][3] for DITA-OT and published via [MkDocs][4] to illustrate the capabilities of modern collaboration and publishing toolchains based on Markdown and how they may be combined with DITA content.
## Sample MkDocs output
The Markdown source files in this repository were rendered with MkDocs and the [Material for MkDocs theme][5].
The demonstration output is available on the GitHub project site at [infotexture.github.io/ot-mkdocs-demo][6].
The content was generated from the [DITA-OT 4.0.2 docs][7] as hosted on the _DITA Open Toolkit_ project website at [www.dita-ot.org/4.0/][8].
## Reporting issues
Since plain-text formats like Markdown are inherently simple, they cannot represent the full range of semantics encoded in DITA content, so some information is lost in translation when exporting DITA content to Markdown.
With that in mind, if you see errors in the exported Markdown or have suggestions on enhancing the Markdown conversion routine, please submit them to [jelovirt/org.lwdita/issues][9].
If you notice issues in the content of the docs themselves, please report them via [dita-ot/docs/issues][10].
[1]: https://www.dita-ot.org
[2]: https://daringfireball.net/projects/markdown/
[3]: https://github.com/jelovirt/org.lwdita
[4]: https://www.mkdocs.org
[5]: https://squidfunk.github.io/mkdocs-material
[6]: https://infotexture.github.io/ot-mkdocs-demo
[7]: https://github.com/dita-ot/docs/tree/4.0.2
[8]: https://www.dita-ot.org/4.0/
[9]: https://github.com/jelovirt/org.lwdita/issues
[10]: https://github.com/dita-ot/docs/issues