site_name: Bioxel Nodes Handbook
site_url: https://omoolab.github.io/BioxelNodes/
site_author: OmooLab
site_description: Bioxel Nodes is a Blender add-on for scientific volumetric data visualization.

repo_name: OmooLab/BioxelNodes
repo_url: https://github.com/OmooLab/BioxelNodes

nav:
  - index.md
  - Getting Started:
      - Installation: installation.md
      - Prepare Your Data: prepare_data.md
      - Step by Step: step_by_step.md
      - Concepts & Pipeline: concept.md
  - Visualizating any Bio-structure:
      - Import & Preprocess: import.md
      - Mask Methods: mask.md
      - Assgin a Shader: shader.md
      - Cut the Component: cut.md
      - Set Colors: color.md
      - Integration into Other Pipeline: intergration.md
      - Render Tips: render.md
  - Reference:
      - Terms: terms.md
      - Nodes: nodes.md
      - Benchmark: benchmark.md

theme:
  name: material
  favicon: assets/logo.png
  logo: assets/logo.png
  language: en
  font:
    text: Open Sans
    code: Cascadia Code
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: black
      toggle:
        icon: fontawesome/solid/circle-half-stroke
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      toggle:
        icon: fontawesome/regular/moon
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: fontawesome/solid/moon
        name: Switch to system preference
  features:
    - header.autohide
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - content.code.copy
    - content.code.select

extra:
  version:
    provider: mike
    default: latest

extra_css:
  - stylesheets/extra.css

copyright: Copyright © 2020 - 2024 Omoolab

plugins:
  - search
  - mkdocstrings

markdown_extensions:
  - attr_list
  - md_in_html
  - mkdocs-click
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true