mkdocs.yml

site_name: Leafcloud Documentation
site_url: https://docs.leaf.cloud
site_description: Official documentation for Leafcloud - sustainable cloud computing platform
site_author: Leafcloud

# Repository
repo_name: Leafcloud Documentation
repo_url: https://github.com/leafcloudhq

# Copyright
copyright: Copyright © 2025 Leafcloud - Sustainable Cloud Computing

nav:
  - Home: index.md
  - Getting Started:
      - Getting-Started/index.md
      - Launch Your First Instance: Getting-Started/Launching-an-instance.md
      - Enable 2FA & Security: Getting-Started/Changing-your-password.md
      - Invite Team Members: Getting-Started/managing-your-team.md
      - Next Steps:
          - Creating DNS Records: Getting-Started/Creating-subdomain.md
          - Using OpenStack CLI: Getting-Started/Using-Openstack-CLI.md
  - OpenStack:
      - openstack/index.md
      - Compute:
          - Launching an Instance: Getting-Started/Launching-an-instance.md
          - Connecting to your Instance: Getting-Started/Log-in-to-your-instance.md
          - Key Pairs: Getting-Started/Key-pairs.md
          - Security Groups: Getting-Started/Configuring-security-groups.md
      - Volumes:
          - Creating a Volume: volumes/Creating-a-new-volume.md
          - Attaching a Volume: volumes/Attaching-a-volume-to-your-instance.md
          - Creating a Volume Backup: volumes/Creating-a-volume-backup.md
          - Live Volume Extension: volumes/Live-volume-extension.md
          - Resizing a Volume: volumes/Resizing-a-volume.md
          - Making a Volume Snapshot: volumes/Make-a-volume-snapshot.md
      - Object Storage:
          - Using Object Storage (S3): object-storage/using-object-storage.md
      - Network:
          - Creating a Network: network/Creating-a-new-network.md
          - Creating a Router: network/Creating-a-new-router.md
          - Floating IP: network/Floating-IP.md
          - Creating a Load Balancer: network/Creating-a-load-balancer.md
          - Load Balancer with SSL Certificate: network/Creating-a-load-balancer-with-offload-SSL-Certificate.md
          - Site-to-Site VPN: network/Setup-site-to-site-vpn.md
          - Add Interface to Instance: network/Add-an-interface-to-an-existing-instance.md
      - DNS:
          - Creating a Subdomain: Getting-Started/Creating-subdomain.md
      - Tools:
          - Using the OpenStack CLI: Getting-Started/Using-Openstack-CLI.md
  - Kubernetes:
      - kubernetes/index.md
      - Managed Kubernetes (Gardener):
          - Creating a Cluster: gardener/creating-a-kubernetes-cluster.md
          - Installing gardenctl: gardener/gardenctl.md
          - Temporary Kubeconfig: gardener/temporary-kubeconfig.md
          - Secure CI/CD Deployment: gardener/secure-cicd-deployment.md
          - Advanced Networking: gardener/advanced-networking.md
          - Gardener DNS: gardener/gardener-dns.md
          - WebAssembly: gardener/serverless-webassembly.md
      - Unmanaged Kubernetes:
          - Talos:
              - Creating a Talos Cluster: talos/creating-talos-cluster.md
      - Applications & Services:
          - Installing Helm: kubernetes/installing-helm.md
          - NVIDIA GPU Operator: kubernetes/installing-nvidia-gpu-operator.md
          - NGINX Ingress with Let's Encrypt: kubernetes/ingress-with-nginx-letsencrypt.md
          - Creating a PostgreSQL Cluster: kubernetes/creating-a-postgresql-cluster.md
          - PostgreSQL Backups: kubernetes/scheduling-backups-of-a-PostgreSQL-database.md
          - Creating a FerretDB Database: kubernetes/creating-a-ferretdb-database.md
  - Billing and Cost:
      - billing-and-cost/index.md
      - Managing Your Payment Method: billing-and-cost/payment-methods.md
      - Managing Cloud Costs: billing-and-cost/managing-cost.md
  - Infrastructure as Code:
      - orchestration/index.md
      - Terraform:
          - Creating Instances: terraform/creating-instances.md
          - Hosting Backend State in Object Store: terraform/tf-state.md
      - Ansible:
          - Creating Instances: ansible/creating-instances.md
  - Applications:
      - applications/index.md
      - Nextcloud:
          - Deploying Nextcloud: Nextcloud/deploying-nextcloud.md
          - Implementing S3 as Primary Storage: Nextcloud/implementing-s3-as-primary-storage.md
      - Claris Filemaker:
          - Deploying on Ubuntu: Claris Filemaker/deploying-claris-filemaker-on-ubuntu.md
      - WordPress:
          - Deploying WordPress: wordpress/wordpress-tutorial.md
  - AI/ML & Data Science:
      - data-science/index.md
      - Private LLM:
          - Why Run Your Own LLM Server?: private-llm/why-private-llm.md
          - Open WebUI with Ollama: private-llm/private-llm-with-openwebui-and-ollama.md
          - Setup Private LLM on Kubernetes: private-llm/setup-private-llm.md
          - Team OpenCode with vLLM: private-llm/team-opencode-vllm.md
          - Configuring OpenCode Client: private-llm/opencode-client-setup.md
      - GPU Computing:
          - Installing GPU Drivers: data-science/installing-gpu-drivers.md
          - Using a GPU: data-science/using-a-gpu.md
      - Jupyter:
          - All-in-one Jupyter Image: data-science/using-the-jupyter-image.md
          - Setting up Jupyter: data-science/running-jupyter.md
          - JupyterLab with Miniconda: data-science/running-jupyterlab-with-miniconda.md

theme:
  name: material
  logo: assets/image/logo.svg
  favicon: assets/image/favicon.svg
  
  # Color palette
  palette:
    # Light mode
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    
    # Dark mode (optional)
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  
  # Features
  features:
    # navigation.instant removed - causes scroll and navigation issues
    # navigation.instant.progress removed - not needed without instant loading
    - navigation.tracking       # Update URL with active anchor
    - navigation.tabs           # Top-level tabs
    - navigation.tabs.sticky    # Sticky tabs
    # - navigation.sections     # REMOVED: Prevents collapsible sections - sections are now collapsible
    # - navigation.expand         # Expand navigation by default (disabled for collapsible sections)
    - navigation.path           # Show navigation path
    - navigation.indexes        # Attach pages to sections
    - navigation.top            # Back to top button
    - navigation.footer         # Previous/next links in footer
    - toc.follow                # TOC follows scroll
    - toc.integrate             # Integrate TOC with navigation
    - search.suggest            # Search suggestions
    - search.highlight          # Highlight search results
    - search.share              # Share search results
    - content.code.copy         # Copy code button
    - content.code.annotate     # Code annotations
    - content.action.edit       # Edit page button
    - content.action.view       # View source button
  
  # Icons
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye
    
  # Font (will be overridden by CSS with Season font)
  font:
    text: Roboto
    code: Roboto Mono

# Plugins
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
      lang: en

# Extra configuration
extra:
  generator: false
  
  # Social links
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/leafcloudhq
      name: Leafcloud on GitHub
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/company/leafcloud-bv
      name: Leafcloud on LinkedIn
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/leafcloudhq
      name: Leafcloud on Twitter
    - icon: fontawesome/brands/youtube
      link: https://youtube.com/@leafcloudhq
      name: Leafcloud on YouTube
  
  # Analytics (add if you have Google Analytics)
  # analytics:
  #   provider: google
  #   property: G-XXXXXXXXXX
  
  # Alternate languages (if you add translations)
  # alternate:
  #   - name: English
  #     link: /en/
  #     lang: en

# Custom CSS
extra_css:
  - stylesheets/extra.css

# Markdown extensions
markdown_extensions:
  - admonition                    # Admonition boxes
  - pymdownx.details              # Collapsible admonitions
  - pymdownx.superfences:         # Code blocks with syntax highlighting
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:              # Content tabs
      alternate_style: true
  - pymdownx.highlight:           # Code highlighting
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite         # Inline code highlighting
  - pymdownx.snippets             # Include snippets
  - pymdownx.critic               # Track changes
  - pymdownx.caret                # Superscript
  - pymdownx.keys                 # Keyboard keys
  - pymdownx.mark                 # Highlighting
  - pymdownx.tilde                # Subscript
  - pymdownx.emoji:               # Emoji support
      emoji_index: !!python/name:pymdownx.emoji.twemoji
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.tasklist:            # Task lists
      custom_checkbox: true
  - attr_list                     # Attribute lists
  - def_list                      # Definition lists
  - footnotes                     # Footnotes
  - md_in_html                    # Markdown in HTML
  - tables                        # Tables
  - toc:                          # Table of contents
      permalink: true
      permalink_title: Anchor link to this section
      toc_depth: 3