mkdocs.yml

site_name: RIVET Wiki
repo_name: TurakhiaLab/rivet
repo_url: https://github.com/TurakhiaLab/rivet

theme:
  name: material
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.footer
    - navigation.expand
    - navigation.tabs.sticky
    - navigation.instant.prefetch
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - toc.integrate
  language: en
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  favicon: images/rivet-icon.png
  logo: images/rivet-icon.png

  icon:
  admonition:
    note: octicons/tag-16
    info: octicons/info-16
    tip: octicons/squirrel-16
    success: octicons/check-16
    question: octicons/question-16
    warning: octicons/alert-16
    bug: octicons/bug-16
    example: octicons/beaker-16
    quote: octicons/quote-16

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/TurakhiaLab/rivet

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.mark
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

use_directory_urls: false
nav:
  - Home: index.md
  #- RIVET Web Interface:
  #  - start/features.md
  #  - start/table.md
  #  - start/filtration.md
  #  - start/future.md
  #- Use RIVET Locally:
  #  - installation/installation.md
  #  - installation/upload.md
  #  - installation/analyze.md
  #- Contributing: 
  #  - contributing/contributing.md

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