mkdocs.yaml

site_name: Documentation
site_description: |
  The documentation for the pynxtools-xps plugin.
site_author: The NOMAD Authors
repo_url: https://github.com/FAIRmat-NFDI/pynxtools-xps
edit_uri: ""

nav:
  - Home: index.md
  - Tutorials:
      - tutorial/installation.md
      - tutorial/standalone.md
      - tutorial/nexusio.md
      - tutorial/nomad.md
  - How-To Guides:
      - how-tos/build_a_reader.md
  - Explanation:
      - explanation/implementation.md
      - explanation/appdefs.md
      - explanation/contextualization.md
      - explanation/data_processing.md
      - explanation/nomad_integration.md
  - Reference:
      - reference/specs.md
      - reference/scienta.md
      - reference/phi.md
      - reference/vms.md

plugins:
  - search
  - macros:
      module_name: src/pynxtools_xps/mkdocs

theme:
  name: material
  palette:
    primary: '#2A4CDF'
    accent: '#008A67'
  font:
    text: 'Titillium Web'
  logo: assets/nomad-plugin-logo.png
  favicon: assets/favicon.png
  features:
    - navigation.instant
    - navigation.footer
    - content.code.copy
    - content.code.annotate
  custom_dir: docs/theme
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - toc:
      permalink: True
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.emoji
  - mkdocs-click
  - pymdownx.extra
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

extra:
  generator: false

use_directory_urls: false

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascript.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js