wiki/mkdocs.yml at master · entity-toolkit/wiki · 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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
site_name: "Entity: wiki"
repo_url: https://github.com/entity-toolkit/entity
repo_name: entity
site_url: https://entity-toolkit.github.io/wiki/
# site_url: https://haykh.github.io/entity-wiki-test/

nav:
  - Home: index.md
  - Getting Started:
      - content/1-getting-started/1-compile-run.md
      - content/1-getting-started/2-dependencies.md
      - content/1-getting-started/3-inputfile.md
      - content/1-getting-started/8-docker.md
  - How-To:
      - content/2-howto/1-problem_generators.md
      - content/2-howto/2-vis.md
      - content/2-howto/3-units.md
      - content/2-howto/4-checkpoints.md
      - content/2-howto/5-docs.md
      - content/2-howto/6-guidelines.md
      - content/2-howto/7-faq.md
  - Understanding the Code:
      - content/3-code/1-pic.md
      - content/3-code/2-hierarchy.md
      - content/3-code/3-domains.md
      - content/3-code/4-fields_particles.md
      - content/3-code/5-metrics.md
      - content/3-code/6-higherorder.md
      - content/3-code/7-radiative.md
  - Useful Things:
      - content/useful/costtool.md
      - content/useful/cluster-setups.md
  - Theory:
      - content/useful/float-comparison.md
      - content/useful/theory_pic.md
      - content/useful/ks.md
  - Fun:
      - content/fun/pushers.md
      - content/fun/coords.md
      - content/fun/cubed_sphere.md
      - content/fun/particle-shapes.md
  - Events:
      - content/events/sceecs2024/instructions.md

markdown_extensions:
  - 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
      clickable_checkbox: true
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid-diagram
          class: mermaid-diagram
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets
  - toc:
      permalink: true
  - tables
  - attr_list
  - admonition
  - md_in_html
  # - footnotes
  # - def_list
  # - neoteroi.cards
  # - neoteroi.timeline

plugins:
  - tags
  - search
  - macros

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: ntt-light
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode

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

extra_css:
  - css/style.css

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

copyright: Copyright &copy; 2021++, Entity dev team