mkdocs.yml

site_name: Wannier90 Documentation
site_url: https://wannier90.readthedocs.io/
# site_url: https://wannier.org/
site_author: Wannier90 Developers
site_description: >-
  Wannier90 user guide and tutorials

repo_name: wannier-developers/wannier90
repo_url: https://github.com/wannier-developers/wannier90

copyright: Copyright © 2006 - 2024 Wannier90 Developers

nav:
  - Home: "index.md"
  - "Tutorials":
      - "1: Graphene — Projectability-disentangled Wannier functions": "tutorials/ex1.md"
      - "2: Silicon — Projectability-disentangled Wannier functions with custom projectors": "tutorials/ex2.md"
      - "3: Silicon — Manifold-remixed Wannier functions": "tutorials/ex3.md"

theme:
  name: material
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.footnote.tooltips
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.instant.prefetch
    # - navigation.instant.progress
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference
  font:
    text: Roboto
    code: Roboto Mono
  logo: assets/wannier-logo-squared.svg
  favicon: assets/wannier-logo-squared.png

extra:
  status:
    new: Recently added
    deprecated: Deprecated
  # analytics:
  #   provider: google
  #   property: !ENV GOOGLE_ANALYTICS_KEY
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/wannier-developers/wannier90

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: wannier-developers
      repo: wannier90
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

plugins:
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
  - git-committers:
      # enabled: !ENV ["ENABLE_MKDOCS_GIT_COMMITTERS"]
      repository: wannier-developers/wannier90
      branch: develop
      token: !ENV ["GITHUB_TOKEN"]
  - search
  - glightbox
  - bibtex:
      # `bib_file` takes precedence over `bib_dir`, if `bib_file` is defined,
      # the bibtex plugin will use an absolute path to the file, meaning that
      # we can only execute `mkdocs build` in the folder `REPO_root/docs`.
      # With `bib_dir` the bibtex plugin will use a relative path to the
      # `mkdocs.yml` file, and search recursively for all the bib files.
      # Therefore, it is possible to execute `mkdocs build` in both the
      # `REPO_root` and the `REPO_root/docs` folder, then readthedocs can build
      # the docs (since readthedocs always builds the docs in the `REPO_root`).
      # bib_file: refs.bib
      bib_dir: .
      # default "{number}", to avoid conflict with user-defined footnotes
      footnote_format: "ref{number}"
  - exporter
  - exporter-pdf:
      # skip generating PDFs if the MKDOCS_EXPORTER_ENABLED environment variable
      # is not true, to speed up development
      enabled: !ENV [MKDOCS_EXPORTER_ENABLED, true]
      concurrency: 8
      # covers:
      #   front: resources/templates/covers/front.html.j2
      #   back: resources/templates/covers/back.html.j2
      # stylesheets:
      #   - docs/stylesheets/pdf.scss
  - exporter-extras:
      buttons:
        - title: Download as PDF
          enabled: !!python/name:mkdocs_exporter.plugins.pdf.button.enabled
          icon: !!python/name:mkdocs_exporter.plugins.pdf.button.icon
          attributes:
            href: !!python/name:mkdocs_exporter.plugins.pdf.button.href
            download: !!python/name:mkdocs_exporter.plugins.pdf.button.download

extra_javascript:
  - javascripts/mathjax.js
  - javascripts/mkdocs-exporter.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  # - javascripts/katex.js
  # - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
  # - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js

extra_css:
  - stylesheets/custom.css
  # - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css