mkdocs.yml

site_name: Torchbox
repo_url: https://github.com/torchbox/torchbox.com
site_url:
edit_uri: 'edit/main/docs/'

repo_name: Github
dev_addr: 0.0.0.0:8001

theme:
  name: material
  font: false
  palette:
    # Palette toggle for light mode
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: red
      accent: red
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  features:
    - content.code.annotate
    - content.code.copy
    - navigation.footer
    - navigation.top
    - navigation.indexes
    - toc.follow
    - navigation.expand

markdown_extensions:
  - attr_list
  - admonition
  - codehilite
  - footnotes
  - sane_lists
  - toc:
      permalink: true
  # pymdown-extensions meant to bring the Markdown implementation closer to GFM.
  - pymdownx.details
  - pymdownx.magiclink
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - 'Home': 'index.md'
  - 'General principles': 'general-principles.md'
  - 'External documentation': 'external-docs.md'
  - 'Infrastructure': 'infrastructure.md'
  - 'Project conventions': 'project-conventions.md'
  - 'Page models': 'page-models.md'
  - 'Accessibility testing': 'accessibility-testing.md'
  - 'Deployment': 'deployment.md'
  - 'VSCode Dev container': 'vscode-dev-container.md'
  - 'Front end':
      - front-end/breakpoints.md
      - front-end/design-guide.md
      - front-end/fonts.md
      - front-end/grid.md
      - 'Streamfield blocks and re-usable components': front-end/streamfield-blocks.md
      - front-end/sustainability.md
      - front-end/responsive-images.md
      - front-end/themes_and_modes.md
      - front-end/tooling.md
      - front-end/placeholder-images.md
      - front-end/utility-classes.md
      - front-end/motif-headings.md
      - 'Markdown block and codehilite': 'front-end/markdown-codehilite.md'
      - front-end/impact-report.md
      - front-end/lite-youtube.md
      - front-end/facebook-app-id.md
      - front-end/incident-form.md
  - 'Navigation': 'navigation.md'
  - 'Custom features':
      - 'Migration-friendly StreamFields': 'custom-features/migration-friendly-streamfields.md'
      - 'Theme': 'custom-features/theme.md'
      - 'Modes': 'custom-features/modes.md'
      - 'Contact': 'custom-features/contact.md'
  - 'Continuous integration': 'continuous-integration.md'
  - 'Anonymised data': 'anonymised-data.md'
  - 'Data import': 'data-import.md'
  - 'Upgrading guidelines': 'upgrading.md'
  - 'Hotjar tracking in wagtail admin': 'hotjar-tracking.md'
  - 'Runbook': 'support-runbook.md'