crow/mkdocs.yaml

site_name: Crow CI
site_url: https://www.crowci.dev/
repo_url: https://codeberg.org/crowci/crow
repo_name: crowci/crow
edit_uri: _edit/main/docs/
theme:
  name: material
  custom_dir: docs/overrides
  logo: logo.svg
  favicon: favicon.png
  icon:
    repo: simple/codeberg
    edit: material/pencil
    view: material/eye
  palette:
    # Palette toggle for automatic mode
    - media: '(prefers-color-scheme)'
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: '(prefers-color-scheme: light)'
      scheme: custom-light
      # accent: yellow
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      # https://github.com/squidfunk/mkdocs-material/issues/5537
      primary: custom
      # accent: custom
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to system preference

  font:
    text: Roboto
    code: Roboto Mono
  features:
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-loading
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.prune
    - navigation.indexes
    - navigation.footer
    - toc.follow
    - navigation.top
    - search.suggest
    - search.highlight
    - header.autohide
    - content.action.edit
    - content.code.copy
    - announce.dismiss
    # insiders
    - navigation.instant.preview
    - navigation.instant.prefetch
    - navigation.instant.progress

extra:
  version:
    provider: mike
  generator: false

copyright: >
  Copyright © 2025 - 2025 Crow CI

plugins:
  - mike:
      alias_type: redirect
  - privacy
  - social:
      cards_layout: default/variant
      cards_layout_options:
        color: '#fff'
        background_color: '#1e2129'
        font_family: Inter
        description: Crow CI is a Continuous Integration & Continuous Delivery (CI/CD) application. It is designed to be lightweight, simple to use and fast.
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true
  # https://github.com/blueswen/mkdocs-glightbox#usage
  - glightbox:
      width: 80%

  - group:
      enabled: !ENV IS_CI
      plugins:
        - optimize
        - privacy
  # local execution
  - group:
      enabled: !ENV INSIDERS
      plugins:
        - optimize
        - privacy

extra_css:
  - stylesheets/extra.css
extra_javascript:
  - javascripts/extra.js

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - footnotes
  - attr_list
  - md_in_html
  - pymdownx.blocks.caption
  - pymdownx.blocks.admonition:
      types:
        - note
        - abstract
        - info
        - important
        - tip
        - success
        - question
        - warning
        - failure
        - danger
        - bug
        - example
        - quote

nav:
  - Getting started: index.md
  - Installation:
      - installation/index.md
      - Docker compose: installation/docker-compose.md
      - Helm: installation/helm.md
      - Reverse proxy setup: installation/proxy.md
      - CLI: installation/cli.md
      - Migration from other apps: installation/migration.md
  - Configuration:
      - configuration/index.md
      - Server: configuration/server.md
      - Agent: configuration/agent.md
      - Autoscaler: configuration/autoscaler.md
      - All environment variables: configuration/env-vars.md
  - Usage:
      - usage/index.md
      - Pipelines & Workflows: usage/pipelines.md
      - Workflow syntax: usage/workflow-syntax.md
      - Repository settings: usage/repo-settings.md
      - Secrets: usage/secrets.md
      - Cron jobs: usage/cron.md
      - Deployment jobs: usage/deployment.md
      - Volumes: usage/volumes.md
      - Environment variables: usage/env-vars-usage.md
      - Registries: usage/registries.md
      - Services: usage/services.md
      - Advanced: usage/advanced.md
  - Plugins: plugins/index.md
  - Ecosystem:
      - ecosystem/index.md
      - Socials: ecosystem/socials.md
      - Community Assets: ecosystem/community.md
  - Development:
      - development/index.md