docs/mkdocs.yml at main · yaptide/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
site_name: User Documentation
site_url: https://yaptide.github.io/docs/
repo_url: https://github.com/yaptide/docs
repo_name: yaptide/docs
copyright: Copyright &copy; 2023-2025 the YAPTIDE team


theme:
  name: material
  features:
    - content.code.annotate
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top

nav:
- Home:
  - Overview: index.md
  - Geometry and materials: geometry.md
  - Scoring: scoring.md
  - Particle source and physics: settings.md
  - Running simulations: running.md

plugins:
  - search
  - git-revision-date-localized
  - pdf-export:
      enabled_if_env: ENABLE_PDF_EXPORT
      combined: true
  - glightbox

markdown_extensions:
  - attr_list
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true