zensical.toml

[project]
site_name = "Documentation"
site_url = "https://docs.superphenix.net"
site_description = "Build your own cloud platform with Superphenix"
repo_url = "https://github.com/super-phenix/superphenix"
repo_name = "super-phenix/superphenix"
docs_dir = "docs"
site_dir = "site"
extra_css = ["stylesheets/extra.css"]
copyright = "Copyright © 2026 The Superphenix authors"

nav = [
  { "Home" = "home.md" },
  { "Architecture" = [
    { "Overview" = "architecture/index.md" },
    { "Deployment topology" = "architecture/deployment-topology.md" },
    { "Hardware requirements" = "architecture/deployment-requirements.md" },
    { "Network requirements" = "architecture/network-requirements.md" }
  ]},
  { "Installation" = [
    { "Getting started" = "installation/getting-started.md" },
    { "Deployment guide" = [
      { "Overview" = "installation/deployment-guide/index.md" },
      { "Installing management plane" = [
        { "Overview" = "installation/deployment-guide/installing-management/index.md" },
        { "Installing inside an AZ" = "installation/deployment-guide/installing-management/management-inside-az.md" },
        { "Installing outside an AZ" = [
          { "Overview" = "installation/deployment-guide/installing-management/management-outside-az.md" },
          { "Full configuration" = "installation/deployment-guide/installing-management/full-configuration.md" }
        ]}
      ]},
      { "Installing the OS" = [
        { "Manual OS installation" = "installation/deployment-guide/installing-the-os/manual-os-installation.md" },
        { "Automated OS installation" = "installation/deployment-guide/installing-the-os/automated-os-installation.md" }
      ]},
      { "Installing an AZ" = [
        { "Overview" = "installation/deployment-guide/installing-an-az/index.md" },
        { "Installing hyperconverged" = "installation/deployment-guide/installing-an-az/installing-hyperconverged.md" },
        { "Installing decoupled" = "installation/deployment-guide/installing-an-az/installing-decoupled.md" },
        { "Configure a cluster" = "installation/deployment-guide/installing-an-az/configuring-a-cluster.md" }
      ]}
    ]},
    { "Production recommendations" = "installation/production-recommendations.md" }
  ]},
  { "Features" = [
    { "Overview" = "features/index.md" },
    { "Compute" = "features/compute/index.md" },
    { "Network" = "features/network/index.md" },
    { "Storage" = "features/storage/index.md" },
  ]},
  { "User Guides" = [
    { "Network" = [
      { "Overview" = "user-guides/network/index.md" },
      { "Create a subnet with a NAT gateway" = "user-guides/network/create-a-subnet.md" },
      { "Create a security group" = "user-guides/network/create-a-security-group.md" }
    ]},
    { "Virtual machines" = [
      { "Overview" = "user-guides/virtual-machines/index.md" },
      { "Create a virtual machine" = "user-guides/virtual-machines/create-a-vm.md" },
      { "Expose a VM with an Elastic IP" = "user-guides/virtual-machines/expose-with-eip.md" }
    ]}
  ]},
  { "Operations" = [
    { "Accessing Superphenix" = "operations/accessing-superphenix.md" },
    { "Limitations" = "operations/limitations.md" },
    { "Network" = [
      { "Configure NAT gateways" = "operations/network/configure-nat-gateways.md" },
      { "Setting the MTU of subnets" = "operations/network/setting-the-mtu-of-subnets.md" },
      { "IPv6 configuration" = "operations/network/ipv6-configuration.md" },
      { "Hairpin NAT" = "operations/network/hairpin-nat.md" }
    ]},
    { "Storage" = [
      { "Configuring the storage cluster" = "operations/storage/configuring-the-storage-cluster.md" },
      { "Connecting a workload and storage cluster" = "operations/storage/connecting-a-workload-and-storage-cluster.md" },
      { "Adding a storage class" = "operations/storage/adding-a-storage-class.md" },
      { "Adding an object store" = "operations/storage/adding-an-object-store.md" },
      { "Using local storage" = "operations/storage/using-local-storage.md" }
    ]},
    { "Web console" = "operations/console.md" }
  ]},
  { "PaaS" = [
    { "KaaS" = [
      { "Overview" = "paas/kaas/index.md" },
      { "Basic operations" = "paas/kaas/basic-operations.md" },
      { "Advanced configuration" = "paas/kaas/advanced-configuration.md" },
      { "Disaster recovery" = "paas/kaas/disaster-recovery.md" },
      { "Network configuration" = "paas/kaas/network-configuration.md" }
    ]}
  ]},
  { "Contributing" = "contributing.md" },
  { "Enterprise support" = "enterprise-support.md" }
]

# SEO and meta tags
[[project.extra.meta]]
name = "description"
content = "Superphenix documentation: A full cloud stack running on your own hardware"

[[project.extra.meta]]
name = "keywords"
content = "Kubernetes, KubeVirt, CNI, CSI, hypervisor, Superphenix, CNCF, cloud-native, Ceph, Rook, Kube-OVN, cloud service provider"

# Markdown extensions (grids, icons, content tabs, admonitions, code blocks)
[project.markdown_extensions.attr_list]
[project.markdown_extensions.admonition]
[project.markdown_extensions.md_in_html]
[project.markdown_extensions.pymdownx.emoji]
emoji_index = "zensical.extensions.emoji.twemoji"
emoji_generator = "zensical.extensions.emoji.to_svg"
[project.markdown_extensions.pymdownx.highlight]
anchor_linenums = true
line_spans = "__span"
pygments_lang_class = true
[project.markdown_extensions.pymdownx.inlinehilite]
[project.markdown_extensions.pymdownx.snippets]
[project.markdown_extensions.pymdownx.superfences]
[project.markdown_extensions.pymdownx.tabbed]
alternate_style = true
[project.markdown_extensions.pymdownx.details]

# Theme
[project.theme]
# variant = "classic"
custom_dir = "overrides"
logo = "assets/spx.svg"
favicon = "assets/favicon.svg"
features = ["announce.dismiss", "content.code.copy"]

# Light/dark palette toggle (same as Material)
[[project.theme.palette]]
scheme = "default"
primary = "black"
toggle.icon = "lucide/sun"
toggle.name = "Switch to dark mode"

[[project.theme.palette]]
scheme = "slate"
primary = "black"
toggle.icon = "lucide/moon"
toggle.name = "Switch to light mode"

[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/super-phenix/superphenix"