mkdocs.yml

# Copyright (c) 2023-2024, Nubificus LTD
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

site_name: urunc Documentation
nav:
  - Home: index.md
  - Quickstart: quickstart.md
  - Installation: installation.md
  - VMM/Sandbox Support: hypervisor-support.md
  - Unikernel Support: unikernel-support.md
  - Packaging unikernels: image-building.md
  - Design:
      - design/*.md
  - Developer Guide: 
      - developer-guide/*.md
      - API Reference: https://pkg.go.dev/github.com/nubificus/urunc@v0.3.0/pkg/unikontainers
  - Tutorials:
      - tutorials/*.md

theme:
  name: material
  favicon: img/urunc-logo.png
  logo: img/urunc-logo.png
  palette: 

    # Palette toggle for light mode
    - scheme: default
      primary: white
      accent: indigo
      toggle:
        icon: material/eye
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: black
      accent: light blue
      toggle:
        icon: material/eye-outline
        name: Switch to light mode

features:
  - navigation.instant
  - navigation.sections
  - navigation.expand
  - toc.integrate

markdown_extensions:
  - footnotes
  - attr_list

toc:
  - permalink: true

copyright: Copyright © 2022 - 2024 Nubificus LTD

extra_css:
  - stylesheets/extra.css
gtags:
  - G-X2S0PFR6ZY
plugins:
  - section-index
  - literate-nav