mkdocs.yml

# SPDX-FileCopyrightText: 2024 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
# SPDX-FileCopyrightText: 2024 Jonas Huber <https://github.com/jh-rli> © Reiner Lemoine Institut
# SPDX-License-Identifier: MIT

# Project
site_name: Open Energy Metadata
site_url: https://openenergyplatform.github.io/oemetadata/
site_description: Documentation of the Open Energy Metadata (OEMetadata) standard

# Repository
repo_name: OpenEnergyPlatform/oemetadata
repo_url: https://github.com/OpenEnergyPlatform/oemetadata
docs_dir: docs

# Configuration
theme:
  name: material
  logo: img/OpenEnergyFamily_Logo_OEMetadata_white.png
  palette:
      # Palette toggle for light mode
      - scheme: default
        toggle:
          icon: material/brightness-7
          name: Switch to dark mode
      # Palette toggle for dark mode
      - scheme: slate
        toggle:
          icon: material/brightness-4
          name: Switch to light mode
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.path
    - navigation.tracking
    - navigation.top
    - toc.follow

# extensions 
markdown_extensions:
  - admonition
  - tables
  - toc:
      permalink: "#"

plugins:
- mkdocstrings:
- search:
    separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'

# Customization
extra:
  generator: false
  version:
    provider: mike
  homepage: https://openenergyplatform.org/

extra_css:
  - extra.css

# Navigation
nav:
  - Home: index.md
  - Development:
    - Collaboration:
      - development/collaboration/index.md
      - License: development/collaboration/license.md
      - Citation: development/collaboration/citation.md
      - Contributing: development/collaboration/contributing.md
      - Users: development/collaboration/users.md
      - Code of Conduct: development/collaboration/code_of_conduct.md
    - Git:
      - development/git/index.md
      - Gitignore: development/git/gitignore.md
    - Documentation:
      - development/documentation/index.md
    - Release:
      - development/release/index.md
  - Metadata Documentation:
      - metadata/index.md
      - Key Description: metadata/metadata_key_description.md
      - Metadata Mappings: metadata/metadata_mappings.md
  - Code Documentation:
    - Install:
      - code/install/index.md
    - Tests:
      - code/tests/index.md