PineAPFEL/mkdocs.yml at main · QCDLab/PineAPFEL · 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
site_name: PineAPFEL

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/pineapfel.svg
  favicon: assets/pineapfel.svg
  palette:
    scheme: default
    primary: white
    accent: blue
  features:
    - navigation.footer
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy

extra_css:
  - custom.css
  - assets/stylesheets/notebooks.css
  - https://cdn.jsdelivr.net/gh/devicons/devicon@latest/devicon.min.css

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

nav:
  - HOME: index.md
  - GETTING STARTED:
      - Building & Installing: building.md
  - USAGE:
      - Configuration cards: configuration-cards.md
      - Grid creation: grid-creation.md
      - CLI Interface: cli.md
      - Using as a Library: library.md
      - Python API: python-api.md
      - QCD vs QCD⊗QED: evolution-modes.md

plugins:
  - search
  - mermaid2

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  - attr_list
  - admonition
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com
      name: GitHub
    - icon: fontawesome/solid/comments
      link: https://zulipchat.com
      name: Zulip Chat