mkdocs.yml

site_name: Slicer
site_description: Slice bare-metal into sandboxes and services
site_author: OpenFaaS Ltd
site_url: https://docs.slicervm.com/

# Repository
repo_name: slicervm/docs.slicervm.com
repo_url: https://github.com/slicervm/docs.slicervm.com
edit_uri: ""

copyright: |
  Copyright © 2025 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.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top

  include_search_page: false
  search_index_only: true

  language: en

  favicon: images/favicon.ico

extra_css:
  - stylesheets/extra.css

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

nav:
  - Linux:
      - Introduction: index.md
      - Contact us: contact.md
      - Getting Started:
          - Installation: getting-started/install.md
          - Walkthrough: getting-started/walkthrough.md
          - Running in the background: getting-started/daemon.md
      - Examples:
          - AI/LLMs:
              - Sandboxing Coding Agents: examples/coding-agents.md
              - Ollama with a GPU: examples/gpu-ollama.md
              - Headless OpenCode Coding Agent: examples/opencode-agent.md
          - Kubernetes:
              - HA Kubernetes: examples/ha-k3s.md
              - Autoscaling Kubernetes: examples/autoscaling-k3s.md
              - Large scale Kubernetes: examples/large-scale-k3s.md
              - Multiple machine Kubernetes: examples/multiple-machine-k3s.md
              - K3s with a GPU: examples/k3s-gpu.md
              - OpenFaaS on K3s: examples/openfaas.md
          - Productivity:
              - Remote Docker builds over SSH: examples/buildkit.md
              - Remote VSCode: examples/remote-vscode.md
              - PiHole Adblocker: examples/pihole-adblock.md
          - Run Jenkins for CI/CD: examples/jenkins.md
          - Create a Linux Router/Firewall: examples/router-firewall.md
          - Run containers with Docker: examples/docker.md
          - OpenFaaS Edge (All-In-One): examples/openfaas-edge.md
      - Tasks:
          - Customise with userdata: tasks/userdata.md
          - Copy files to/from a VM: tasks/copy-files.md
          - Execute commands in a VM: tasks/execute-commands.md
          - Expose ports from a VM: tasks/expose-ports.md
          - Intercept VM egress: tasks/intercept-egress.md
          - Build a custom root filesystem: tasks/custom-image.md
          - Logs & Monitoring: tasks/monitoring.md
          - Share files over NFS: tasks/share-files-with-nfs.md
          - Nested Virtualization: tasks/nested-virtualization.md
          - Run slicer without KVM on cloud VMs: tasks/pvm.md
      - Storage:
          - Overview: storage/overview.md
          - ZFS: storage/zfs.md
          - Devmapper: storage/devmapper.md
      - Reference:
          - REST API: reference/api.md
          - YAML Config: reference/yaml.md
          - Images for microVMs: reference/images.md
          - SSH access to VMs: reference/ssh.md
          - Secret management: reference/secrets.md
          - Custom Certificate Authority: reference/ca-trust.md
          - Serial Over SSH (SOS): reference/sos.md
          - Networking: reference/networking.md
          - VFIO Passthrough: reference/vfio.md
          - Troubleshooting: reference/troubleshooting.md
  - Platform:
      - Overview: platform/overview.md
      - Quickstart: platform/quickstart.md
      - VM Lifecycle: platform/lifecycle.md
      - Go SDK: platform/go-sdk.md
      - TypeScript SDK: platform/typescript-sdk.md
      - Run a task in Slicer: platform/ephemeral-tasks.md
      - Slicer per host: platform/single-instance.md
      - Slicer per tenant: platform/instance-per-tenant.md
      - Examples:
          - Video conversion (Go): platform/video-conversion.md
          - Video conversion (TypeScript): platform/typescript-video-conversion.md
      - REST API Reference: reference/api.md
      - OpenAPI Spec: platform/openapi.md
      - Build a custom image: platform/custom-images.md
      - Publish your own images: platform/publish-images.md
  - Proxy:
    - Overview: proxy/overview.md
    - Setup for Mac: proxy/mac.md
    - Setup for Linux: proxy/linux.md
    - Secret Injection: proxy/secret-injection.md
    - Transparent Proxy Helper: proxy/transparent.md
  - Mac:
      - Overview: mac/overview.md
      - Installation: mac/installation.md
      - Persistent Linux VM: mac/linux-vm.md
      - Sandboxes: mac/sandboxes.md
      - Troubleshooting: mac/troubleshooting.md
      - Configuration:
          - Enable Rosetta: mac/rosetta.md
          - Storage: mac/storage.md
          - Folder sharing: mac/folder-sharing.md
          - Docker: mac/docker.md
          - Sleep behavior: mac/sleep.md
          - Tray integration: mac/tray-integration.md
      - Examples:
          - Sandboxing Coding Agents: mac/coding-agents.md
# extra:
#   analytics:
#     provider: google
#     property: G-PTK21TFJ7V
#     anonymize_ip: true