mkdocs.yml

site_name: Actuated
site_description: Realise the potential of blazingly fast builds.
site_author: OpenFaaS Ltd
site_url: https://docs.actuated.com/

# Repository
repo_name: self-actuated/actuated
repo_url: https://github.com/self-actuated
edit_uri: ""

copyright: |
  Copyright © 2023 OpenFaaS Ltd
theme:
  name: material
  # custom_dir: docs/theme
  logo: images/logo.png

  palette:
  - scheme: default
    primary: black
    toggle:
      icon: material/toggle-switch-off-outline
      name: Switch to dark mode
  - scheme: slate
    primary: black
    toggle:
      icon: material/toggle-switch
      name: Switch to light mode

  font:
    text: Roboto, Helvetica
    code: Roboto Mono
  features:
    - navigation.tracking
    - navigation.sections
    - navigation.expand

  include_search_page: false
  search_index_only: true

  language: en

  # favicon: images/favicon.ico

extra:
  search:
    languages: "en"
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/self-actuated/
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/selfactuated

plugins:
  - search
  
markdown_extensions:
  - attr_list
  - tables
  - md_in_html
  - 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
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Overview:
      - Introduction: index.md
      - Dashboard: dashboard.md
      - FAQ: faq.md
      - Roadmap: roadmap.md
      - Contact us: contact.md
  - Onboarding:
      - Register your GitHub Organisation: register.md
      - Provision a Server: provision-server.md
      - Install the Agent: install-agent.md
      - Run a test build: test-build.md
  - Tasks:
    - Right Size the VM: tasks/right-size-vm.md
    - Setup a Registry Mirror: tasks/registry-mirror.md
    - Debug a job with SSH: tasks/debug-ssh.md
    - Set-up the CLI: tasks/cli.md
    - Setup self-hosted cache: tasks/local-github-cache.md
    - Monitoring: tasks/monitoring.md
    - Troubleshooting: troubleshooting.md

  - Examples:
      - System Info: examples/system-info.md
      - Job Matrix: examples/matrix.md
      - Compile a Kernel: examples/kernel.md
      - Kubernetes with K3s: examples/k3s.md
      - Kubernetes with KinD: examples/kind.md
      - Kubernetes regression matrix: examples/matrix-k8s.md
      - Docker run/build: examples/docker.md
      - Publish an OpenFaaS function: examples/openfaas-publish.md
      - Deploy a Helm chart: examples/openfaas-helm.md
      - Custom VM sizes: examples/custom-vm-size.md
      - Using caching in builds: examples/github-actions-cache.md
  - Advanced examples:
    - Run a KVM guest: examples/kvm-guest.md
    - Multi-arch images with buildx: examples/multiarch-buildx.md

extra:
  analytics:
    provider: google
    property: G-PTK21TFJ7V
    anonymize_ip: true