mkdocs.yml

site_name: Burrow
site_description: A modular Go web framework built on Chi, Den, and html/template
site_url: https://burrow.readthedocs.io/
repo_url: https://github.com/oliverandrich/burrow
repo_name: oliverandrich/burrow
copyright: "© 2026 Oliver Andrich. All rights reserved."

extra_css:
  - stylesheets/extra.css

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.suggest

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/oliverandrich/burrow

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
      - Project Structure: getting-started/project-structure.md
      - Scaffold: getting-started/scaffold.md
      - Examples & Tutorial: getting-started/examples.md
      - Tooling: getting-started/tooling.md
  - Guide:
      - Core:
          - Creating an App: guide/creating-an-app.md
          - Routing: guide/routing.md
          - Error Handling: guide/error-handling.md
          - Database: guide/database.md
          - Database Migrations: guide/migrations.md
          - Configuration: guide/configuration.md
      - Templates & UI:
          - Layouts & Rendering: guide/layouts.md
          - Navigation: guide/navigation.md
          - Tailwind CSS: guide/tailwind.md
          - Forms: guide/forms.md
          - Validation: guide/validation.md
          - Internationalization: guide/i18n.md
      - Advanced:
          - JSON CRUD APIs: guide/crud-api.md
          - Pagination: guide/pagination.md
          - Full-Text Search: guide/fts5.md
          - File Uploads: guide/uploader.md
          - Inter-App Communication: guide/inter-app-communication.md
      - Testing:
          - Testing: guide/testing.md
      - Deployment:
          - Deployment: guide/deployment.md
          - Building Releases: guide/releases.md
          - Logging: guide/logging.md
          - TLS: guide/tls.md
          - Client IP: guide/client-ip.md
          - Reverse Proxy: guide/reverse-proxy.md
  - Tutorial:
      - Overview: tutorial/index.md
      - "Part 1: Setup & First View": tutorial/part1.md
      - "Part 2: Database & Models": tutorial/part2.md
      - "Part 3: Templates & Layouts": tutorial/part3.md
      - "Part 4: Forms, CRUD & Validation": tutorial/part4.md
      - "Part 5: Authentication": tutorial/part5.md
      - "Part 6: Admin Panel": tutorial/part6.md
      - "Part 7: HTMX, Charts & Pagination": tutorial/part7.md
      - "Part 8: Custom Admin Views": tutorial/part8.md
  - Contrib Apps:
      - Core:
          - CSRF: contrib/csrf.md
          - Healthcheck: contrib/healthcheck.md
          - Messages: contrib/messages.md
          - Session: contrib/session.md
      - Auth:
          - Auth: contrib/auth.md
          - Extending the User: contrib/auth-profile.md
          - Auth Mail: contrib/authmail.md
      - Security:
          - Rate Limiting: contrib/ratelimit.md
          - Security Headers: contrib/secure.md
      - UI & Templates:
          - htmx: contrib/htmx.md
          - Static Files: contrib/staticfiles.md
          - API Docs: contrib/apidocs.md
      - Formatting:
          - Humanize: contrib/humanize.md
      - Data & Background:
          - Admin: contrib/admin.md
          - Jobs: contrib/jobs.md
          - SSE: contrib/sse.md
      - Distribution:
          - Selfupdate: contrib/selfupdate.md
  - Reference:
      - Core Interfaces: reference/interfaces.md
      - Core Functions: reference/core-functions.md
      - Sub-packages:
          - app: reference/app.md
          - server & registry: reference/server.md
          - web: reference/web.md
          - tasks: reference/tasks.md
          - pagination: reference/pagination.md
      - Configuration Reference: reference/configuration.md
      - Template Functions: reference/template-functions.md
      - Reusable Templates: reference/reusable-templates.md
      - Context Helpers: reference/context-helpers.md
      - CLI: reference/cli.md
  - Migration:
      - "v0.30": migration/v0.30.md
      - "v0.27": migration/v0.27.md
      - "v0.25": migration/v0.25.md
      - "v0.24": migration/v0.24.md
      - "v0.23": migration/v0.23.md
      - "v0.22": migration/v0.22.md
      - "v0.20": migration/v0.20.md
  - Contributing: contributing.md
  - Changelog: changelog.md
  - License: license.md