mkdocs.yml

repo_url: https://github.com/cirruslabs/cirrus-ci-docs/
site_url: https://cirrus-ci.org
edit_uri: blob/master/docs/

site_name: Cirrus CI
site_author: Cirrus Labs
copyright: © Cirrus Labs 2017-present
site_description: >
  Cirrus CI is a modern Continuous Integration system built for the era of cloud computing.
  Cirrus CI supports Linux, Windows, macOS and FreeBSD environments as well as various cloud computing
  services like Kubernetes, Google Cloud, AWS and Azure.

remote_branch: master

theme:
  name: 'material'
  custom_dir: 'theme'
  favicon: 'assets/images/favicon.ico'
  logo: 'assets/images/logo.svg'
  icon:
    repo: fontawesome/brands/github
  language: en
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to light mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - announce.dismiss
    - content.tabs.link
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - search.suggest

extra_css:
  - 'stylesheets/extra.css'
  - 'stylesheets/landing.css'

plugins:
  - search
  - minify

markdown_extensions:
  - markdown.extensions.admonition
  - markdown.extensions.codehilite:
      guess_lang: false
  - markdown.extensions.def_list
  - markdown.extensions.footnotes
  - markdown.extensions.meta
  - markdown.extensions.toc:
      permalink: true
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Home: index.md
  - Features: features.md
  - Documentation:
    - 'User Guide':
      - 'Quick Start': guide/quick-start.md
      - 'Writing Tasks': guide/writing-tasks.md
      - 'Programming Tasks in Starlark': guide/programming-tasks.md
      - 'Configuration Tips and Tricks': guide/tips-and-tricks.md
      - 'Execution Environment':
        - 'Linux Containers': guide/linux.md
        - 'Windows Containers': guide/windows.md
        - 'macOS VMs': guide/macOS.md
        - 'FreeBSD VMs': guide/FreeBSD.md
        - 'Persistent Workers': guide/persistent-workers.md
        - 'Docker Builder on VM': guide/docker-builder-vm.md
        - 'Docker Builds on GKE': guide/docker-builds-on-kubernetes.md
        - 'Docker Pipe': guide/docker-pipe.md
        - 'Custom VMs': guide/custom-vms.md
        - 'Computing Services': guide/supported-computing-services.md
      - 'Life of a Build': guide/build-life.md
      - 'Notifications': guide/notifications.md
    - API: api.md
    - FAQ: faq.md
    - Legal:
      - 'Privacy': legal/privacy.md
      - 'Terms of Service': legal/terms.md
    - Security: security.md
  - Examples: examples.md
  - Pricing: pricing.md
  - Support: support.md
  - Blog: https://medium.com/cirruslabs
  - Go to App: https://cirrus-ci.com/

extra:
  social:
    - icon: fontawesome/brands/twitter
      link: 'https://twitter.com/cirrus_labs'