Edit

TechDocs FAQ

This page answers frequently asked questions about TechDocs.

Technology

• What static site generator is TechDocs using?
• What is the mkdocs-techdocs-core plugin?
• Does TechDocs support file formats other than Markdown (e.g. RST, AsciiDoc)?

What static site generator is TechDocs using?

TechDocs is using MkDocs to build project documentation under the hood. Documentation built with the techdocs-container is using the MkDocs Material Theme.

What is the mkdocs-techdocs-core plugin?

The mkdocs-techdocs-core package is a MkDocs Plugin that works like a wrapper around multiple MkDocs plugins (e.g. MkDocs Monorepo Plugin) as well as a selection of Python Markdown extensions that TechDocs supports.

Does TechDocs support file formats other than Markdown (e.g. RST, AsciiDoc) ?

Not right now. We are currently using MkDocs to generate the documentation from source, so the files have to be in Markdown format. However, in the future we want to support other static site generators which will make it possible to use other file formats.