mkdocs.yml

#===================================================================================#
# Site Information
#===================================================================================#
site_name: Nauticus
repo_name: "edixos/Nauticus"
site_description: Nauticus Simplifies Kubernetes cluster management with fully-managed Spaces.
repo_url: https://github.com/edixos/Nauticus
site_author: Edixos
copyright: >
  Copyright © 2023-2024 Edixos. 
  <a href="#__consent">Change cookie settings</a>

#===================================================================================#
# Mkdocs Theme (Material Mkdocs) + Extras
#===================================================================================#
theme:
  name: material
  custom_dir: overrides
  logo: assets/images/logos/nauticus-logo-textless-small.png

  features:
    - content.tabs.link #Insiders only so far
    - navigation.tabs
    - navigation.instant
    - header.autohide
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.expand
    - content.code.copy
    - announce.dismiss
  font:
    text: Raleway
    code: Ubuntu Sans Mono

  palette: # https://www.materialpalette.com/colors
    - scheme: slate
      primary: yellow # comment to replace by /docs/assets/stylesheets
      accent:  amber
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: default
      primary: yellow # comment to replace by /docs/assets/stylesheets
      accent: amber
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  include_sidebar: true

  icon:
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16

#===================================================================================#
# Mkdocs Markdown Extensions, Plugins & extras
#===================================================================================#
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - codehilite
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.tabbed
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.smartsymbols
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      # insert a blank space before the character
      permalink: " ¶"

plugins:
  - search
  - include-markdown

extra:
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
  version:
    provider: mike
  analytics:
    provider: google
    property: G-YSCQHVX2PE
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! 

  generator: false
  social:
    - icon: material/github
      link: 'https://github.com/edixos/nauticus'
    - icon: material/slack
      link: 'https://kubernetes.slack.com/archives/C04NQTC3R0F'
  logo: assets/images/logos/nauticus-logo-textless-small.png


#===================================================================================#
# Mkdocs Navigation Tree
#===================================================================================#
nav:
  - Home: index.md
  - Getting started:
      - Installation: getting-started.md

  - Tutorials:
      - Space Tutorial: tutorials/space-tutorial.md
      - Space Template Tutorial: tutorials/space-templates-tutorial.md

      - Ignore Underlying Deletion: tutorials/ignore-underlying-deletion.md
  - Reference:
      - API Specification: crds-apis.md
  - Community:
      - Contributing:
          - Contribution Process: contributing/process.md
          - Developer Guide: contributing/dev-guide.md
          - Code Of Conduct: contributing/coc.md