mkdocs.yml

site_name: "Pixi by prefix.dev"
site_url: https://prefix-dev.github.io/pixi

theme:
  name: material
  custom_dir: docs/overrides
  favicon: assets/pixi.png
  logo: assets/pixi.png
  site_url: https://prefix.dev
  font:
    text: Red Hat Text
    code: JetBrains Mono

  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: prefix-light
      accent: prefix-light
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: prefix
      accent: prefix
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  icon:
    edit: material/pencil
    view: material/eye

  features:
    - content.tabs.link
    - content.code.copy
    - content.action.edit
    - content.code.annotate
    # - content.code.select Sponsor only
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.footer

extra_css:
  - stylesheets/extra.css

repo_url: https://github.com/prefix-dev/pixi/
edit_uri: edit/main/docs/

markdown_extensions:
  - admonition
  - def_list
  - footnotes
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      toc_depth: 3
      permalink: "#"
  - mdx_truly_sane_lists

extra:
  homepage: https://prefix.dev
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/prefix_dev
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/prefix-dev
    - icon: fontawesome/brands/github
      link: https://github.com/prefix-dev
  version:
    provider: mike

nav:
  - Installation: index.md
  - Basic Usage: basic_usage.md
  - Switching from:
      - Poetry: switching_from/poetry.md
      - Conda/Mamba: switching_from/conda.md
  - Changelog: CHANGELOG.md
  - IDE Integration:
      - JupyterLab: ide_integration/jupyterlab.md
      - PyCharm: ide_integration/pycharm.md
      - RStudio: ide_integration/r_studio.md
      - VSCode Devcontainer: ide_integration/devcontainer.md
  - Tutorials:
      - Python: tutorials/python.md
      - ROS 2: tutorials/ros2.md
      - Rust: tutorials/rust.md
  - Examples:
      - C++/Cmake: examples/cpp-sdl.md
      - OpenCV: examples/opencv.md
      - ROS 2: examples/ros2-nav2.md
  - Features:
      - Environments: features/environment.md
      - Tasks: features/advanced_tasks.md
      - Multi Platform: features/multi_platform_configuration.md
      - Multi Environment: features/multi_environment.md
      - Lockfile: features/lockfile.md
      - System Requirements: features/system_requirements.md
      - Global Tools: features/global_tools.md
  - Advanced:
      - Authentication: advanced/authentication.md
      - Info Command: advanced/explain_info_command.md
      - Channel Logic: advanced/channel_priority.md
      - GitHub Actions: advanced/github_actions.md
      - Updates using GitHub Actions: advanced/updates_github_actions.md
      - Production Deployment: advanced/production_deployment.md
      - Pyproject.toml: advanced/pyproject_toml.md
  - Reference:
      - Project Configuration: reference/project_configuration.md
      - Pixi Configuration: reference/pixi_configuration.md
      - CLI: reference/cli.md
  - Misc:
      - Pixi vision: vision.md
      - Packaging: packaging.md
      - Community: Community.md
      - FAQ: FAQ.md

hooks:
  - schema/docs_hooks.py
  - install/docs_hooks.py
  - docs/docs_hooks.py

plugins:
  - redirects:
      redirect_maps:
        "advanced/advanced_tasks.md": "features/advanced_tasks.md"
        "environment.md": "features/environment.md"
        "design_proposals/multi_environment_proposal.md": "features/multi_environment.md"
        "advanced/multi_platform_configuration.md": "features/multi_platform_configuration.md"
        "cli.md": "reference/cli.md"
        "configuration.md": "reference/project_configuration.md"
        "advanced/global_configuration.md": "reference/pixi_configuration.md"

  - search
  - social
  - mike:
    # These fields are all optional; the defaults are as below...
    # alias_type: symlink
    # redirect_template: null
    # deploy_prefix: ''
    # canonical_version: null
    # version_selector: true
    # css_dir: css
    # javascript_dir: js