https://github.com/infotexture/ot-docs-writerside

Markdown export of the DITA Open Toolkit documentation and Writerside demo output
https://github.com/infotexture/ot-docs-writerside

Last synced: 2 days ago
JSON representation

Markdown export of the DITA Open Toolkit documentation and Writerside demo output

• Host: GitHub
• URL: https://github.com/infotexture/ot-docs-writerside
• Owner: infotexture
• Created: 2023-12-26T15:53:47.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-04-15T20:09:09.000Z (7 months ago)
• Last Synced: 2024-10-12T19:48:17.533Z (about 1 month ago)
• Homepage: https://infotexture.github.io/ot-docs-writerside
• Size: 954 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: ReadMe.md

Awesome Lists containing this project

README

        


# DITA Open Toolkit Docs — Writerside 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 [Writerside][4] to illustrate the capabilities of modern collaboration and publishing toolchains based on Markdown and how they may be combined with DITA content.

## Sample Writerside output

The Markdown source files in the `docs/` folder on the `master` branch of this repository were generated from the [DITA-OT 4.1.2 docs][5] as hosted on the _DITA Open Toolkit_ project website at [www.dita-ot.org/4.1/][6].

The demonstration output on the `gh-pages` branch was rendered with the [Writerside][4] 2023.2 Early Access Program build #WRS-232.10275, built on November 29, 2023 and published on the GitHub project site at [infotexture.github.io/ot-docs-writerside][7].

## 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][8].

If you notice issues in the content of the docs themselves, please report them via [dita-ot/docs/issues][9].

[1]: https://www.dita-ot.org

[2]: https://daringfireball.net/projects/markdown/

[3]: https://github.com/jelovirt/org.lwdita

[4]: https://www.jetbrains.com/writerside/

[5]: https://github.com/dita-ot/docs/tree/4.1.2

[6]: https://www.dita-ot.org/4.1/

[7]: https://infotexture.github.io/ot-docs-writerside/

[8]: https://github.com/jelovirt/org.lwdita/issues

[9]: https://github.com/dita-ot/docs/issues