mkdocs.yml

site_name: "Entity: wiki"
repo_url: https://github.com/entity-toolkit/entity
repo_name: entity
site_url: https://entity-toolkit.github.io/wiki

nav:
  - Home: index.md
  - Getting started:
      - Compiling/running: getting-started/compile-run.md
      - Dependencies: getting-started/dependencies.md
      - Docker: getting-started/docker.md
      - Input file: getting-started/inputfile.md
      # - Writing a problem generator: getting-started/pgen.md
      - Understanding the units: getting-started/units.md
      - Output & visualization: getting-started/vis.md
      - Writing checkpoints & restarting: getting-started/checkpoints.md
      - Documenting: getting-started/docs.md
      - F.A.Q.: getting-started/faq.md
  - PIC algorithm: "numerics/pic.md"
  - Understanding the code:
      - "code/hierarchy.md"
      - "code/domains.md"
      - "code/fields_particles.md"
      - "code/metrics.md"
      - "code/problem_generators.md"
      # - "code/structure.md"
  - Guidelines: "guidelines.md"
  - Useful things:
      - Floating point comparison: "useful/float-comparison.md"
      - Theory behind PIC: "useful/theory_pic.md"
      - Kerr metric: "useful/ks.md"
  - Fun:
      - Axisymmetric coordinates: "fun/coords.md"
      - Cubed sphere: "fun/cubed_sphere.md"
  - Events:
      - SCEECS Summer School 2024: "events/sceecs2024/instructions.md"
         

markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      use_pygments: true
      pygments_lang_class: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true
  - tables
  - attr_list
  - admonition
  - footnotes
  - def_list
  - pymdownx.details
  - pymdownx.superfences
  - md_in_html
  - neoteroi.cards
  - neoteroi.timeline

plugins:
  - tags
  - search
  - macros
  - extra-sass

use_directory_urls: true

theme:
  name: material
  custom_dir: overrides
  favicon: assets/logo.svg
  logo: assets/logo.svg
  icon:
    repo: simple/git
    annotation: material/plus-circle-outline

  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
  font:
    text: "DM Sans"
    code: "JetBrains Mono"
  features:
    - navigation.tracking
    # - navigation.prune
    - toc.integrate
    - content.code.annotate
    - content.code.copy
    - navigation.indexes
    - content.tooltips
    - header.autohide
    # - navigation.top
    # - navigation.instant

extra_css:
  - https://cdn.jsdelivr.net/npm/katex@0.16.10/dist/katex.min.css
  - css/tikzjax/fonts.css

extra_javascript:
  - js/katex.js
  - https://cdn.jsdelivr.net/npm/katex@0.16.10/dist/katex.min.js
  - https://cdn.jsdelivr.net/npm/katex@0.16.10/dist/contrib/auto-render.min.js
  - js/tikzjax.js

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/entity-toolkit/entity/

copyright: Copyright © 2021++, Entity dev team