mkdocs.yml

site_name: Jupyter4NFDI
site_description: Jupyter4NFDI project overview
site_author: WG RSE, NFDI Section Common Infrastructures, Jupyter4NFDI
site_url: "https://NFDI-Jupyter.github.io/services"
theme:
  name: material 
  features:
    - nagivation.tabs
    - navigation.sections
    - navigation.collapse
    - toc.integrate
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  language: en
  logo: images/base4nfdi_logo.png
  favicon: images/nfdi_rgb_Wortmarke.png
  custom_dir: docs/custom
  palette:
    - scheme: fzj
      primary: teal
      accent: purple

plugins:
  - mkdocs-jupyter
  - social
  - search
  - gen-files:
      scripts:
        - docs/plugins/gen_detail_pages.py
  - macros:
      include_dir: include
  - mkdocs-simple-hooks:
      hooks:
        on_pre_build: "data.hooks:generate_cards"

extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - js/tablesort.js

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  - md_in_html
  - meta
  - tables
  - def_list
  - neoteroi.cards
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.mark
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra_css:
  - css/style.css
  - css/neoteroi-cards.css
  - css/extra.css

extra:
  logo: "images/logo.png"

copyright: |
  &copy; 2024 Forschungszentrum Jülich | <a href="/imprint" target="_blank">Legal Notice</a>


nav:
  - General:
    - Overview: index.md
    - Authentication: authentication.md
    - 2-Factor authentication: 2fa.md
    - Available Resources and Tools: features.md
  - For Users:
    - JupyterLab 4.2: users/jupyterlab/4.2/index.md
    - Custom Docker Images: users/jupyterlab/customdockerimage/index.md
    - Repo2Docker ( Binder ): users/jupyterlab/repo2docker/index.md
    - Useful Tips & Tricks: users/misc.md
  - For Resource Providers:
    - Overview: providers/index.md
    - Architecture: providers/architecture.md
    - Installation: providers/installation.md
    - Configuration: providers/configuration.md
  - JupyterHubs within NFDI:
    - Overview: hubs/index.md
    - Statistics about the Jupyter services collected: hubs/stats.md
    - Join the list: hubs/template.md
  - Support: support.md


plugins:
  - search
  - gen-files:
      scripts:
        - docs/hubs/plugins/gen_detail_pages.py
  - macros:
      include_dir: include
  - mkdocs-simple-hooks:
      hooks:
        on_pre_build: "docs.hubs.plugins.hooks:generate_cards"