docs.dt.in.th

docs.dt.in.th builds upon the Antora multi-repository documentation site generator to provide an improved authoring workflow through a custom CLI script, inspired by Backstage’s TechDocs.

The source code is on GitHub.

Easy to author with high fidelity previewing

By running the dtinth-docs command, a project documentation can be previewed in isolation through a local development server.
The development server automatically rebuilds the documentation whenever a file is changed.
See more information in Authoring guide.

How it works

The CLI generates an Antora playbook file on-the-fly, so documentation can be previewed in isolation without having to manually clone the documentation repo, setting up Antora, and updating playbook files.

Easy to add new project documentations

New documentation can be added to the site by adding a new entry in the Google Sheets spreadsheet, so there is no need to fiddle with playbook files.

Why Antora?

Antora uses AsciiDoc, which is more flexible than Markdown. AsciiDoc has been used successfully for big projects, such as the Elastic stack.
Antora uses Asciidoctor, which is a recommended by AsciiDoc.
Antora is used to generate Asciidoctor’s documentation site.

Minimize laborious tasks

Building and publishing a documentation site is only part of the whole story. How about social share images? How about SEO? How about analytics? These are things that I had to do each time I set up a new documentation site. Putting documentation together in a single place allows each project documentations to benefit from shared tools.

Social image: personal-puppeteer is used to generate screenshots for each page, which are then used for social image. When a documentation page is shared, people can see the contents of the page before clicking on the shared link.
Analytics: Google Analytics integration is supported natively by Antora.