mkdocs.yml

repo_url: https://github.com/cirruslabs/tart/
site_url: https://tart.run/
edit_uri: blob/main/docs/

site_name: Tart Virtualization
site_author: Cirrus Labs
copyright: © Cirrus Labs 2017-present
site_description: >
  Tart is a virtualization toolset to build, run and manage macOS and Linux virtual machines (VMs) on Apple Silicon.

remote_branch: main

theme:
  name: 'material'
  custom_dir: 'docs/theme'
  favicon: 'assets/images/favicon.ico'
  logo: 'assets/images/TartLogo.png'
  icon:
    repo: fontawesome/brands/github
  language: en
  palette:
    - scheme: default
      primary: orange
      accent: orange
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - announce.dismiss
    - content.tabs.link
    - content.code.copy
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - search.suggest
    - toc.follow

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

plugins:
  - blog
  - privacy
  - rss:
      match_path: blog/posts/.*
      date_from_meta:
        as_creation: date
  - social:
      cards_layout_dir: docs/layouts
      cards_layout: custom
      debug: true
  - 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.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - attr_list
  - md_in_html

nav:
  - "Home": index.md
  - "Quick Start": quick-start.md
  - "Integrations":
      - "Self-hosted CI": integrations/cirrus-cli.md
      - "GitHub Actions": https://cirrus-runners.app/
      - "GitLab Runner": integrations/gitlab-runner.md
      - "Buildkite": integrations/buildkite.md
      - "Managing VMs": integrations/vm-management.md
  - "Support & Licensing": licensing.md
  - "Orchestration":
      - "Quick Start": orchard/quick-start.md
      - "Architecture and Security": orchard/architecture-and-security.md
      - "Deploying Controller": orchard/deploying-controller.md
      - "Deploying Workers": orchard/deploying-workers.md
      - "Managing the Cluster": orchard/managing-cluster.md
      - "Integrating with the API": orchard/integration-guide.md
  - "FAQ": faq.md
  - "Legal":
      - 'Terms of Service': legal/terms.md
      - 'Privacy': legal/privacy.md
  - Blog:
      - blog/index.md

extra:
  analytics:
    provider: google
    property: G-HXBEB9D47X
  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.
  social:
    - icon: fontawesome/brands/twitter
      link: 'https://twitter.com/cirrus_labs'