infotexture / ot-docs-markdown

Markdown export of the DITA Open Toolkit documentation and sample GitBook output

Home Page:https://github.com/dita-ot/docs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

DITA Open Toolkit Markdown Demonstration

This repository includes a snapshot of the DITA Open Toolkit documentation in Markdown format.

The output was generated using the DITA-OT Markdown plug-in for publication via GitBook to illustrate the capabilities of modern collaboration and publishing toolchains based on Markdown and how they may be combined with DITA content.

Sample GitBook output

The Markdown source files in this repository were rendered to GitBook’s default static website output via the gitbook-cli command line interface.

The demonstration output is available on the GitHub project site at http://infotexture.github.io/ot-docs-markdown.

The content was generated from the DITA-OT 2.2.2 docs as hosted on the DITA Open Toolkit project website at http://www.dita-ot.org/2.2.

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/dita-ot-markdown/issues.

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

About

Markdown export of the DITA Open Toolkit documentation and sample GitBook output

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