mkdocs.yml

site_name: nmdc-runtime docs
site_description: Documentation for the National Microbiome Data Collaborative (NMDC) Runtime System and API
site_url: https://microbiomedata.github.io/nmdc-runtime/
repo_url: https://github.com/microbiomedata/nmdc-runtime/
edit_uri_template: 'blob/main/docs/{path}'
extra_css:
  - stylesheets/extra.css
nav:
  - index.md
  - Tutorials:
    - tutorials/auth.md
    - tutorials/json.md
    - tutorials/metadata-in.md
    - tutorials/translators.md
    - tutorials/exporters.md
  - How-to guides:
    - howto-guides/author-changesheets.md
    - howto-guides/create-triggers.md
    - howto-guides/claim-and-run-jobs.md
    - howto-guides/update-sensors-ops.md
    - howto-guides/release-process.md
    - howto-guides/improving-search-api.md
    - nb/get_data.ipynb
    - nb/queue_and_trigger_data_jobs.ipynb
    - nb/wf_automation.ipynb
    - Specific Jobs:
      - howto-guides/jobs/gold-translation-etl.md
  - Reference:
    - contributing-docs.md
    - admin.md
  - Explanation:
    - explanation/journeys.md
    - explanation/identifiers.md

theme:
  name: material
  custom_dir: mkdocs_overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

markdown_extensions:
  - admonition
  - attr_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
plugins:
  - search
  - mermaid2:
      arguments:
        securityLevel: 'loose'
  - mkdocs-jupyter