mkdocs.yml

copyright: © MushroomLabs

docs_dir: docs/pages
markdown_extensions:
  - admonition
  - attr_list
  - meta
  - pymdownx.highlight
  - pymdownx.tabbed
  - pymdownx.superfences
  - footnotes

nav:
  - Home: index.md
  - Tutorials:
      - tutorials/index.md
      - Getting started: tutorials/getting_started.md
      - Integrating with your existing Django project: tutorials/integration_with_existing_project.md
      - Using it as a Standalone ActivityPub API Server: tutorials/standalone.md
      - Creating activity handlers: tutorials/activity_handlers.md

  - Topic Guides:
      - topics/index.md
      - Fundamentals of ActivityPub: topics/activitypub_fundamentals.md
      - Models:
          - topics/models/linked_data.md
          - topics/models/activitypub.md
          - topics/models/domains.md
          - topics/models/accounts.md
          - topics/models/messages.md
      - Message Adapters: topics/message_adapters.md
      - Views: topics/views.md
      - Authentication: topics/authn.md
      - Authorization: topics/authz.md
      - Background Tasks: topics/tasks.md
      - Activity Handlers: topics/activity_handlers.md
      - Configuration and Customization: topics/application_settings.md
  - Reference:
      - references/index.md
      - Models: references/models.md

  - HOWTOs:
      - howtos/index.md
      - Register Domain: howtos/register_domain.md
      - Register account: howtos/register_account.md
  - FAQ: faq.md

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            allow_inspection: true
            show_root_heading: true
            show_source: false
            heading_level: 3
  - macros:
      include_dir: docs/snippets

repo_name: mushroomlabs/django-activitypub-toolkit
repo_url: https://codeberg.org/mushroomlabs/django-activitypub-toolkit

site_url: https://activitypub.mushroomlabs.com
site_name: Django ActivityPub ToolKit

theme:
  custom_dir: docs/overrides
  name: material
  icon:
    repo: fontawesome/brands/git-alt
  font:
    text: Ubuntu
    code: Ubuntu Mono
  features:
    - navigation.tabs
    - navigation.indexes
  language: en
  palette:
    primary: indigo
    accent: indigo