mkdocs.yml

site_name: Blazam Documentation
site_description: Documentation for the Blazam application
site_author: Chris Jacobsen
site_url: https://docs.blazam.org
copyright: >
  &copy; Blazam 2022-2025 <br><a href="#__consent">Change cookie settings</a>

repo_url: https://github.com/Blazam-App/BLAZAM
edit_uri: https://github.com/Blazam-App/docs.blazam.org/blob/master/docsource
docs_dir: docsource
site_dir: docs
extra:
  social:
    - icon: fontawesome/brands/github 
      link: https://blazam.org/
    - icon: fontawesome/solid/globe 
      link: https://blazam.org/
  consent:
    title: Cookie consent
    description: >- 
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
  analytics:
    provider: google
    property: G-TG0YV4T565
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >- 
            Thanks for your feedback! Help us improve this page by
            using our <a href="..." target="_blank" rel="noopener">feedback form</a>.
theme:
  features:
    - content.action.edit
    - content.code.copy
    - navigation.footer
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/brightness-7 
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
extra_css:
  - stylesheets/extra.css
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
nav:
    - Home: 'index.md'
    - Security: 'install/security.md'
    - System Requirements: 'install/requirements.md'
    - Installation Guide:
        - Web Installer: 'install/web.md'
        - Manual Installation: 'install/manual.md'
        - Firewalls and Ports: 'install/firewall.md'
        - Configuration: 'install/config.md'

        - Updating:
          - 'Manual Updates': 'update/manual.md'
          - 'Auto Updates': 'update/auto.md'
    - Admin Guide:
      - First Run: 'admin/initialSetup.md'
      - Settings:
        - Application: 'admin/settings/application.md'
        - Authentication: 'admin/settings/authentication.md'
        - Active Directory: 'admin/settings/activeDirectory.md'
        - Email: 'admin/settings/email.md'
        - System: 'admin/settings/system.md'
      - SSO: 'admin/sso.md'
      - Webhooks: 'admin/webhooks.md'
      - Permissions: 'admin/permissions.md'
      - Templates: 'admin/templates.md'
      - Fields: 'admin/fields.md'
      - Rules: 'admin/rules.md'
      - Notifications: 'admin/notifications.md'
      - API: 'admin/api.md'
    - User Guide:
      - User Interface :  'user/index.md'
      - Notifications: 'user/notifications.md'
      - Profile: 'user/profile.md'
      - Password Reset: 'user/password.md'
    - About:
        - 'License': 'license.md'
        - 'Privacy': 'privacy.md'
  

plugins:
  - privacy
  - search