mkdocs.yml

site_name: GitLabForm
repo_url: https://github.com/gitlabform/gitlabform/
docs_dir: docs
strict: true

nav:
  - 🏗 GitLabForm: index.md
  - ✨ Features: features.md
  - 🫴 Requirements: requirements.md
  - 💾 Installation: installation.md
  - 📋 Configuration:
      - reference/index.md
      - Archive/unarchive: reference/archive_unarchive.md
      - Badges: reference/badges.md
      - Branches: reference/protected_branches.md
      - CI/CD Variables: reference/ci_cd_variables.md
      - Deploy Keys: reference/deploy_keys.md
      - Files: reference/files.md
      - Group LDAP links: reference/group_ldap_links.md
      - Integrations: reference/integrations.md
      - Members: reference/members.md
      - Merge Requests: reference/merge_requests.md
      - Pipeline schedules: reference/pipeline_schedules.md
      - Protected environments: reference/protected_environments.md
      - Push rules: reference/push_rules.md
      - Resource groups: reference/resource_groups.md
      - Settings: reference/settings.md
      - Tags protection: reference/tags_protection.md
      - Transfer: reference/project_transfer.md
      - Webhooks: reference/webhooks.md
  - 🏃 Running: running.md
  - 🤖 Automation: automation.md
  - 🗓 Changelog: changelog.md
  - ⏫ Upgrading: upgrade.md
  - 🙋 Contributing:
      - contrib/index.md
      - Local Development: contrib/local_development.md
      - Implementation Design: contrib/implementation_design.md
      - Coding Guidelines: contrib/coding_guidelines.md
      - Releases: contrib/releases.md
  - ⚖️ Similar Apps: similar_apps.md

markdown_extensions:
  - attr_list
  - md_in_html

  - codehilite
  - markdown.extensions.admonition #for !!! notice
  - markdown.extensions.def_list
  - pymdownx.superfences

  - toc:
      permalink: True
      separator: "-"

  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
      options:
        custom_icons:
          - .overrides/.icons

theme:
  name: material
  custom_dir: .overrides
  logo: gitlabform-logo-favicon.png
  favicon: gitlabform-logo-favicon.png

  features:
    - navigation.indexes

  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep orange
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: cyan
      toggle:
        icon: material/weather-night
        name: Switch to light mode