mkdocs.yml

site_name: Stacker Build
site_url: https://stackerbuild.io
site_description: Stacker Build
repo_url: https://github.com/project-stacker/stacker
repo_name: project-stacker/stacker
edit_uri: ""
copyright: Copyright © 2017 - 2023 Cisco Systems Inc., All Rights Reserved.
theme:
  name: material
  custom_dir: material
  palette:
    - scheme: slate
      toggle:
        name: Light Mode
        icon: material/toggle-switch-off-outline
      primary: black
      accent: lime
      media: "(prefers-color-scheme: dark)"
    - scheme: default
      toggle:
        name: Dark Mode
        icon: material/toggle-switch
      primary: black
      accent: teal
      media: "(prefers-color-scheme: light)"
  favicon: assets/images/favicon.png
  logo: assets/images/logo.png
  features:
    - content.code.annotate
    - content.tooltips
    - navigation.instant
    - navigation.tracking
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - search.share
    - toc.follow
    - announce.dismiss
  icon:
    repo: fontawesome/brands/github
  font:
    text: Roboto
    code: Roboto Mono
extra:
  homepage: https://stackerbuild.io
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/project-stacker/stacker.git
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/stackerbuild
    - icon: fontawesome/brands/slack
      link: https://cloud-native.slack.com/archives/C048S8TMBGQ
  generator: false
  version:
    provider: mike
    default: latest
plugins:
  - search
  - git-revision-date-localized
  - minify:
      minify_html: true
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

nav:
  - Home: index.md
  - What's New: whats-new.md
  - Get Started:
    - Get Stacker: get_started/get_stacker.md
    - Hello Stacker Image: get_started/hello_stacker_image.md
    - Stacker Tutorial: get_started/tutorial.md
  - Features: features.md
  - Concepts:
    - About: concepts/about.md
    - OCI Image Layout: concepts/oci_image_layout.md
    - Stacker Architecture: concepts/stacker_architecture.md
  - User Guide:
    - Build Environment: user_guide/build_environment.md
    - Code Builds: user_guide/build_code.md
    - Bootstrapped Container Image: user_guide/scratch_image.md
    - Multi-Stage Build: user_guide/build_container_image.md
    - Template Substitution: user_guide/template_substitution.md
    - Annotation Support: user_guide/annotation_support.md
    - Dependency Builds: user_guide/dependency_builds.md
    - Publish Images: user_guide/publish_images.md
    - Build Cache: user_guide/build_cache.md
    - Inspect Images: user_guide/inspect_images.md
    - Image Chroot: user_guide/image_chroot.md
    - Software Provenance Using SBOMs: user_guide/generate_sbom.md
    - Grab Image Content: user_guide/grab_image_content.md
    - Debugging: user_guide/debugging.md
    - Converting a Dockerfile: user_guide/convert_dockerfile.md
  - Reference:
    - Stacker CLI: reference/stacker_cli.md
    - Stacker File: reference/stacker_file.md
  - Developer Guide:
    - Building Stacker: developer_guide/building_stacker.md
    - Code Structure: developer_guide/code_structure.md
    - LXC Usage: developer_guide/lxc_usage.md
    - OverlayFS Usage: developer_guide/overlayfs_usage.md
    - Contributing: developer_guide/CONTRIBUTING.md
  - License: license.md
extra_css:
  - stylesheets/custom.css