page:
  path: /
  name: Home
  description: "A modern, responsive documentation system for Dash applications built with Dash Mantine Components"
app:
  context: Part of multi-page Dash app with 7 pages
  totalPages: 7
  relatedPages[5]{name,path}:
    AI/LLM Integration,/examples/ai-integration
    Custom Directives,/examples/directives
    Data Visualization,/examples/visualization
    Getting Started,/getting-started
    Interactive .md,/examples/interactive
purpose:
  types[1]: interactive
  explanation[1]: "Interactive: Responds to user interactions via callbacks"
content:
  sections[20]:
    - h: "Welcome to:"
    l: 1
    t: "![logo](assets/intro_img.jpg)\n\n> **A modern, responsive documentation system for Dash applications built with Dash Mantine Components**\n\nCreate beautiful, interactive documentation for your Dash components, data science workflows, and applications with markdown-driven content, live code examples, and automatic theme persistence.\n\n---"
    - h: What is This?
    l: 2
    t: "The Dash Documentation Boilerplate is a **production-ready framework** for creating professional documentation sites for your Dash projects. Whether you're documenting a component library, showcasing data visualizations, or building a comprehensive application guide, this boilerplate provides everything you need."
    - h: Built With Modern Technologies
    l: 3
    t: "- **Dash 3.2.0** - Latest Plotly Dash framework\n- **Dash Mantine Components 2.4.0** - Beautiful, accessible UI components\n- **Mantine 8.3.6** - Modern React component library\n- **React 18** - Latest React features\n- **Python 3.11+** - Modern Python with type hints\n\n---"
    - h: Key Features
    l: 2
    - h: 📝 Markdown-Driven Documentation
    l: 3
    t: "Write your documentation in **markdown files** with full Python integration. The framework automatically discovers markdown files in the `docs/` directory and generates pages with:\n\n- **Frontmatter metadata** for page configuration\n- **Custom directives** for interactive examples\n- **Automatic routing** based on your file structure\n- **Table of contents** generation"
    - h: 🎨 Beautiful UI/UX
    l: 3
    t: "Built with Dash Mantine Components for a modern, professional look:\n\n- **Responsive design** - Works beautifully on mobile, tablet, and desktop\n- **Dark & Light themes** - Automatic theme persistence via localStorage\n- **Smooth transitions** - Professional animations and interactions\n- **Customizable** - Easy to theme with your brand colors\n- **Accessible** - WCAG compliant components"
    - h: 🔧 Custom Directives
    l: 3
    t: "Powerful directives to enhance your documentation:\n\n- `.. toc::` - Generate table of contents from headings\n- `.. exec::module.path` - Embed interactive Python components\n- `.. source::path/to/file.py` - Display source code with syntax highlighting\n- `.. kwargs::ComponentName` - Auto-generate component props documentation"
    - h: 🤖 AI/LLM Integration
    l: 3
    t: "**New in v0.2.0!** Powered by [dash-improve-my-llms](https://pypi.org/project/dash-improve-my-llms/):\n\n- **Automatic AI-friendly documentation** - llms.txt, page.json, architecture.txt\n- **SEO optimization** - sitemap.xml with intelligent priority inference\n- **Bot management** - Control which bots can access your app\n- **Structured data** - Schema.org JSON-LD for better search engines\n- **Share with AI** - Users can share your URL with ChatGPT/Claude for help"
    - h: 🐋 Production Ready
    l: 3
    t: "- **Docker support** - Dockerfile and docker-compose included\n- **Gunicorn server** - Production-ready WSGI server\n- **Environment config** - Easy deployment configuration\n- **Optimized builds** - Fast loading and rendering\n\n---"
    - h: Quick Start
    l: 2
    - h: 1. Installation
    l: 3
    - h: 2. Run the Development Server
    l: 3
    t: "Visit **http://localhost:8553** in your browser."
    - h: 3. Create Your First Documentation Page
    l: 3
    t: "Create a new folder in `docs/` with a markdown file:\n\n\n\nThat's it! Your page will automatically appear in the navigation.\n\n---"
    - h: Example Documentation
    l: 2
    t: "This site includes several example pages to demonstrate the capabilities:\n\n- **Getting Started** - Learn how to create documentation pages\n- **Custom Directives** - See all available directives in action\n- **Interactive Components** - Examples of callbacks and state management\n- **Data Visualization** - Plotly integration examples\n- **AI Integration** - Showcase AI/LLM features\n\n---"
    - h: Project Structure
    l: 2
    t: "---"
    - h: Customization
    l: 2
    - h: Change Primary Color
    l: 3
    t: "Edit `lib/constants.py`:"
    - h: Modify Styles
    l: 3
    t: "- `assets/main.css` - General application styling\n- `assets/m2d.css` - Markdown-specific styling"
    - h: Configure AI/LLM Integration
    l: 3
    t: "Update `run.py` to configure bot management and SEO:\n\n\n\n---"
    - h: Deployment
    l: 2
  codeExamples[8]{lang,code}:
    bash,"# Clone the repository\ngit clone https://github.com/pip-install-python/Dash-Documentation-Boilerplate.git\ncd Dash-Documentation-Boilerplate\n\n# Install Python dependencies\npip install -r requirements.txt\n\n# Install Node dependencies (for Mantine components)\nnpm install"
    bash,python run.py
    markdown,"---\nname: My Component\ndescription: Description of my awesome component\nendpoint: /components/my-component\nicon: mdi:code-tags\n---\n\n## My Component\n\nYour documentation content here...\n\n.. toc::\n\n## Features\n\n- Feature 1\n- Feature 2"
    text,"dash-documentation-boilerplate/\n├── assets/                      # Static assets and CSS\n│   ├── m2d.css                 # Markdown-to-Dash styling\n│   └── main.css                # Custom styles\n│\n├── components/                  # Reusable UI components\n│   ├── appshell.py             # Main app layout\n│   ├── header.py               # Header with search and theme toggle\n│   └── navbar.py               # Navigation sidebar\n│\n├── docs/                        # Your documentation content\n│   └── your-component/\n│       ├── component.md        # Markdown documentation\n│       └── examples.py         # Python interactive examples\n│\n    # ... (7 lines omitted) ...\n│   ├── home.md                 # This home page\n│   ├── home.py                 # Home page layout\n│   └── markdown.py             # Dynamic markdown loader\n│\n├── templates/\n│   └── index.html              # Custom HTML template\n│\n├── CHANGELOG.md                # Version history\n├── README.md                   # Full documentation\n├── LLMS_INTEGRATION.md         # AI/LLM integration guide\n├── requirements.txt            # Python dependencies\n├── package.json                # Node dependencies\n├── Dockerfile                  # Docker container\n└── run.py                      # Application entry point"
    python,"PRIMARY_COLOR = \"teal\"  # Change to any Mantine color"
    python,"from dash_improve_my_llms import RobotsConfig\n\napp._base_url = \"https://your-production-url.com\"\napp._robots_config = RobotsConfig(\n    block_ai_training=True,\n    allow_ai_search=True,\n    crawl_delay=10\n)"
    bash,"# Build the image\ndocker build -t dash-docs-boilerplate .\n\n# Run the container\ndocker run -p 8550:8550 dash-docs-boilerplate"
    bash,docker-compose up
components:
  total: 3
  interactive: 0
  static: 3
  breakdown[2]{type,count}:
    Container,1
    Markdown,1
callbacks:
  total: 37
  flows[10]:
    - n: 1
    updates: url.href
    triggers[1]: "{'id': 'select-component', 'property': 'value'}"
    - n: 2
    updates: components-navbar-drawer.opened
    triggers[1]: "{'id': 'drawer-hamburger-button', 'property': 'n_clicks'}"
    - n: 3
    updates: color-scheme-storage.data
    triggers[1]: "{'id': 'url', 'property': 'pathname'}"
    - n: 4
    updates: m2d-mantine-provider.forceColorScheme
    triggers[1]: "{'id': 'color-scheme-storage', 'property': 'data'}"
    - n: 5
    updates: color-scheme-storage.data@b2871207815a3fc41e578ff4783a4a4c7d85362d7cc85d60481820d4ecc602b4
    triggers[1]: "{'id': 'color-scheme-toggle', 'property': 'n_clicks'}"
    reads[1]: "{'id': 'color-scheme-storage', 'property': 'data'}"
    - n: 6
    updates: analytics-data-store.data
    triggers[1]: "{'id': 'analytics-interval', 'property': 'n_intervals'}"
    - n: 7
    updates: total-stat-value.children
    triggers[1]: "{'id': 'analytics-data-store', 'property': 'data'}"
    - n: 8
    updates: desktop-stat-value.children
    triggers[1]: "{'id': 'analytics-data-store', 'property': 'data'}"
    - n: 9
    updates: mobile-stat-value.children
    triggers[1]: "{'id': 'analytics-data-store', 'property': 'data'}"
    - n: 10
    updates: tablet-stat-value.children
    triggers[1]: "{'id': 'analytics-data-store', 'property': 'data'}"
navigation:
  external[5]{text,href}:
    dash-improve-my-llms,"https://pypi.org/project/dash-improve-my-llms/"
    Dash-Documentation-Boilerplate,"https://github.com/pip-install-python/Dash-Documentation-Boilerplate"
    README.md,"https://github.com/pip-install-python/Dash-Documentation-Boilerplate/blob/main/README.md"
    CHANGELOG.md,"https://github.com/pip-install-python/Dash-Documentation-Boilerplate/blob/main/CHANGELOG.md"
    LLMS_INTEGRATION.md,"https://github.com/pip-install-python/Dash-Documentation-Boilerplate/blob/main/LLMS_INTEGRATION.md"
technical:
  pageType: hybrid
  maxDepth: 2
  hasImportantSections: false
  containsForms: false
  containsVisualizations: false
prose:
  sections[20]:
    - h: "Welcome to:"
    l: 1
    t: "![logo](assets/intro_img.jpg)\n\n> **A modern, responsive documentation system for Dash applications built with Dash Mantine Components**\n\nCreate beautiful, interactive documentation for your Dash components, data science workflows, and applications with markdown-driven content, live code examples, and automatic theme persistence.\n\n---"
    - h: What is This?
    l: 2
    t: "The Dash Documentation Boilerplate is a **production-ready framework** for creating professional documentation sites for your Dash projects. Whether you're documenting a component library, showcasing data visualizations, or building a comprehensive application guide, this boilerplate provides everything you need."
    - h: Built With Modern Technologies
    l: 3
    t: "- **Dash 3.2.0** - Latest Plotly Dash framework\n- **Dash Mantine Components 2.4.0** - Beautiful, accessible UI components\n- **Mantine 8.3.6** - Modern React component library\n- **React 18** - Latest React features\n- **Python 3.11+** - Modern Python with type hints\n\n---"
    - h: Key Features
    l: 2
    - h: 📝 Markdown-Driven Documentation
    l: 3
    t: "Write your documentation in **markdown files** with full Python integration. The framework automatically discovers markdown files in the `docs/` directory and generates pages with:\n\n- **Frontmatter metadata** for page configuration\n- **Custom directives** for interactive examples\n- **Automatic routing** based on your file structure\n- **Table of contents** generation"
    - h: 🎨 Beautiful UI/UX
    l: 3
    t: "Built with Dash Mantine Components for a modern, professional look:\n\n- **Responsive design** - Works beautifully on mobile, tablet, and desktop\n- **Dark & Light themes** - Automatic theme persistence via localStorage\n- **Smooth transitions** - Professional animations and interactions\n- **Customizable** - Easy to theme with your brand colors\n- **Accessible** - WCAG compliant components"
    - h: 🔧 Custom Directives
    l: 3
    t: "Powerful directives to enhance your documentation:\n\n- `.. toc::` - Generate table of contents from headings\n- `.. exec::module.path` - Embed interactive Python components\n- `.. source::path/to/file.py` - Display source code with syntax highlighting\n- `.. kwargs::ComponentName` - Auto-generate component props documentation"
    - h: 🤖 AI/LLM Integration
    l: 3
    t: "**New in v0.2.0!** Powered by [dash-improve-my-llms](https://pypi.org/project/dash-improve-my-llms/):\n\n- **Automatic AI-friendly documentation** - llms.txt, page.json, architecture.txt\n- **SEO optimization** - sitemap.xml with intelligent priority inference\n- **Bot management** - Control which bots can access your app\n- **Structured data** - Schema.org JSON-LD for better search engines\n- **Share with AI** - Users can share your URL with ChatGPT/Claude for help"
    - h: 🐋 Production Ready
    l: 3
    t: "- **Docker support** - Dockerfile and docker-compose included\n- **Gunicorn server** - Production-ready WSGI server\n- **Environment config** - Easy deployment configuration\n- **Optimized builds** - Fast loading and rendering\n\n---"
    - h: Quick Start
    l: 2
    - h: 1. Installation
    l: 3
    t: ""
    - h: 2. Run the Development Server
    l: 3
    t: "Visit **http://localhost:8553** in your browser."
    - h: 3. Create Your First Documentation Page
    l: 3
    t: "Create a new folder in `docs/` with a markdown file:\n\n\n\nThat's it! Your page will automatically appear in the navigation.\n\n---"
    - h: Example Documentation
    l: 2
    t: "This site includes several example pages to demonstrate the capabilities:\n\n- **Getting Started** - Learn how to create documentation pages\n- **Custom Directives** - See all available directives in action\n- **Interactive Components** - Examples of callbacks and state management\n- **Data Visualization** - Plotly integration examples\n- **AI Integration** - Showcase AI/LLM features\n\n---"
    - h: Project Structure
    l: 2
    t: "---"
    - h: Customization
    l: 2
    - h: Change Primary Color
    l: 3
    t: "Edit `lib/constants.py`:"
    - h: Modify Styles
    l: 3
    t: "- `assets/main.css` - General application styling\n- `assets/m2d.css` - Markdown-specific styling"
    - h: Configure AI/LLM Integration
    l: 3
    t: "Update `run.py` to configure bot management and SEO:\n\n\n\n---"
    - h: Deployment
    l: 2
codeExamples[8]{lang,code}:
  bash,"# Clone the repository\ngit clone https://github.com/pip-install-python/Dash-Documentation-Boilerplate.git\ncd Dash-Documentation-Boilerplate\n\n# Install Python dependencies\npip install -r requirements.txt\n\n# Install Node dependencies (for Mantine components)\nnpm install"
  bash,python run.py
  markdown,"---\nname: My Component\ndescription: Description of my awesome component\nendpoint: /components/my-component\nicon: mdi:code-tags\n---\n\n## My Component\n\nYour documentation content here...\n\n.. toc::\n\n## Features\n\n- Feature 1\n- Feature 2"
  text,"dash-documentation-boilerplate/\n├── assets/                      # Static assets and CSS\n│   ├── m2d.css                 # Markdown-to-Dash styling\n│   └── main.css                # Custom styles\n│\n├── components/                  # Reusable UI components\n│   ├── appshell.py             # Main app layout\n│   ├── header.py               # Header with search and theme toggle\n│   └── navbar.py               # Navigation sidebar\n│\n├── docs/                        # Your documentation content\n│   └── your-component/\n│       ├── component.md        # Markdown documentation\n│       └── examples.py         # Python interactive examples\n│\n    # ... (7 lines omitted) ...\n│   ├── home.md                 # This home page\n│   ├── home.py                 # Home page layout\n│   └── markdown.py             # Dynamic markdown loader\n│\n├── templates/\n│   └── index.html              # Custom HTML template\n│\n├── CHANGELOG.md                # Version history\n├── README.md                   # Full documentation\n├── LLMS_INTEGRATION.md         # AI/LLM integration guide\n├── requirements.txt            # Python dependencies\n├── package.json                # Node dependencies\n├── Dockerfile                  # Docker container\n└── run.py                      # Application entry point"
  python,"PRIMARY_COLOR = \"teal\"  # Change to any Mantine color"
  python,"from dash_improve_my_llms import RobotsConfig\n\napp._base_url = \"https://your-production-url.com\"\napp._robots_config = RobotsConfig(\n    block_ai_training=True,\n    allow_ai_search=True,\n    crawl_delay=10\n)"
  bash,"# Build the image\ndocker build -t dash-docs-boilerplate .\n\n# Run the container\ndocker run -p 8550:8550 dash-docs-boilerplate"
  bash,docker-compose up
summary: "A modern, responsive documentation system for Dash applications built with Dash Mantine Components This page has 37 interactive callback(s). Contains 3 components."
_meta:
  gen: dash-improve-my-llms
  v: 1.2.0
  fmt: toon/3.2
  pageType: hybrid