Dash Documentation Boilerplate

Full documentation: https://boilerplate.2plot.dev — the dedicated Documentation boilerplate documentation site, with the complete API reference and deeper examples. This page is the quick-start overview.

Get the Template

Visit GitHub Repo — use it as a GitHub template or clone it directly. It is deliberately not a PyPI package: you fork the repo and make it yours.

git clone https://github.com/pip-install-python/Dash-Documentation-Boilerplate.git my-docs
cd my-docs
pip install -r requirements.txt
python run.py

Introduction

The Dash Documentation Boilerplate is the template every *.2plot.dev component documentation site is forked from — including, in an earlier form, the site you are reading right now. Write documentation as Markdown with frontmatter, drop live Python examples next to it, and pages register themselves: table of contents, searchable navigation, dark/light theme with preference persistence, and interactive code examples with real callbacks.

It is also the network's reference implementation of the AI/SEO standard: every page ships a Markdown twin at /{page}/llms.txt, crawler-ready prerendered HTML, sitemap.xml, robots.txt with per-bot-class policy, and the cross-host network directory — all powered by dash-improve-my-llms.

Full Documentation

The complete documentation lives on its own site: boilerplate.2plot.dev — setup, the directive reference, backend deep dives, the network standard, and the machine-readable twin at boilerplate.2plot.dev/llms.txt. This page is a summary; go there for the full guide.

Writing a Page

A docs page is one Markdown file with frontmatter and directives:

---
name: My Component
description: What it does, in one line
endpoint: /pip/my_component
icon: mdi:code-tags
---

.. toc::

## Quick Start

.. exec::docs.my_component.simple_usage
    :code: false


<!-- Error: File not found: docs/my_component/simple_usage.py -->

Restart the server and the page is registered, in the navigation, in the search index, and serving its own llms.txt.

Features

• Markdown-driven — pages auto-register from docs/**/*.md; custom directives for live examples (.. exec::), collapsible source (.. sourcetabs::), TOC and auto-generated props tables.
• Modern UI — Dash Mantine Components, responsive layout, dark/light theme persistence.
• Pluggable backends — the same app runs on Flask, FastAPI or Quart; switch with a single DASH_BACKEND env var (async callbacks and OpenAPI docs on the ASGI backends).
• AI/LLM & SEO built in — llms.txt on every page, prerendered crawler HTML, sitemap, bot management and the cross-host network directory.
• Production ready — Docker and docker-compose, Gunicorn/Uvicorn configs, CI test suite included.