mkdocs.yml

site_name: dataversefs
site_description: Read-only fsspec filesystem backend for Borealis Dataverse
site_url: https://oceannetworkscanada.github.io/dataversefs
repo_url: https://github.com/OceanNetworksCanada/dataversefs
repo_name: OceanNetworksCanada/dataversefs
copyright: "Copyright © 2025 Martin Heesemann — Ocean Networks Canada"

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: cyan
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: cyan
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - navigation.footer
    - navigation.top
    - search.highlight
    - toc.follow

plugins:
  - search
  - mkdocs-jupyter:
      include_source: true

nav:
  - Home: index.md
  - Tutorials:
      - tutorials/index.md
      - Getting Started: tutorials/getting-started.md
      - Zarr with Xarray (notebook): notebooks/02_zarr_xarray.ipynb
      - FakeQuake Seismic Data (notebook): notebooks/03_fakequake.ipynb
      - API Exploration (notebook): notebooks/01_explore_api.ipynb
  - How-to Guides:
      - howto/index.md
      - Authenticate: howto/authenticate.md
      - Open Zarr with Xarray: howto/open-zarr-xarray.md
      - Read CSV with Pandas: howto/open-csv-pandas.md
      - Search Files with glob(): howto/search-glob.md
      - Enable Logging: howto/enable-logging.md
      - Download Files to Local Disk: howto/download-files.md
      - Cache Files Locally: howto/cache-files.md
      - Work with Zip Archives: howto/work-with-zip-archives.md
  - Reference:
      - reference/index.md
      - Roadmap: roadmap.md
  - Explanation:
      - explanation/index.md

markdown_extensions:
  - admonition
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true