backstage-techdocs-demo

TechDocs Formatting & Visualization Cookbook

This repository is a compendium of practical examples showing how to build beautiful and feature-rich documentation sites with Backstage TechDocs and MkDocs.

What’s inside?

• Guides – Good practices, plugin overview and basic configuration.
• Demo pages – Live examples for:
  • diagrams (Mermaid, PlantUML, Graphviz),
  • math (KaTeX),
  • interactive charts (Vega-Lite),
  • API docs (Swagger UI),
  • task lists,
  • admonitions,
  • code highlighting and more.
• MkDocs configuration – Ready-to-use mkdocs.yaml, requirements.txt and assets.

Visit the docs locally:

pip install -r requirements.txt
npx @techdocs/cli serve

---

Made with ❤️ by DevStage.io