mkdocs.yml

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

site_name: Cirrus CI
site_author: Cirrus Labs
site_description: >
  Cirrus CI is a modern Continuous Integration system built for the era of cloud computing.
  Cirrus CI supports both Linux and Windows environments as well as various cloud computing
  services like Kubernetes and Google Cloud Platform.

google_analytics: ['UA-110620457-1', 'cirrus-ci.org']
remote_branch: master
strict: true

theme:
  name: 'material'
  favicon: 'assets/images/favicon.ico'
  logo: 'assets/images/logo.svg'
  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true
  language: en
  palette:
    primary: indigo
    accent: indigo
  font:
    text: Roboto
    code: Roboto Mono

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.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Home: index.md
  - 'Quick Start': guide/quick-start.md
  - 'Why Cirrus CI': why.md
  - User Guide:
    - 'Writing Tasks': guide/writing-tasks.md
    - 'Linux Containers': guide/linux.md
    - 'Windows Containers': guide/windows.md
    - 'macOS VMs': guide/macOS.md
    - 'Docker Builder': guide/docker-builder.md
    - 'Life of a Build': guide/build-life.md
    - 'Supported Computing Services': guide/supported-computing-services.md
  - Pricing: pricing.md
  - Examples: examples.md
  - API: api.md
  - FAQ: faq.md
  - Legal:
    - 'Privacy': legal/privacy.md
    - 'Terms of Service': legal/terms.md
  - Support: support.md

extra:
  social:
    - type: 'github'
      link: 'https://github.com/cirruslabs'
    - type: 'twitter'
      link: 'https://twitter.com/cirrus_labs'