MechDSL/mkdocs.yml at main · CEmM2/MechDSL · 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
site_name: MechDSL
site_description: Write computational-mechanics models in LaTeX, compile them to tested FEM solver code.
site_url: "https://cemm2.github.io/MechDSL/"
repo_url: https://github.com/CEmM2/MechDSL
repo_name: CEmM2/MechDSL
docs_dir: docs
use_directory_urls: false

theme:
  name: material
  logo: assets/mechdsl-mark.webp
  favicon: assets/mechdsl-mark.webp
  font:
    text: Baloo 2
    code: JetBrains Mono
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - content.code.copy
    - content.code.annotate
    - toc.follow
    - search.suggest
    - search.highlight

extra_css:
  - stylesheets/mechdsl.css

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  # Required for the :material-*: / :octicons-*: icon shortcodes used in the card grids.
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details

nav:
  - Home: index.md
  - Installation: installation.md
  - mechdsl-core:
      - Introduction: mechdsl-core/index.md
      - Getting started: mechdsl-core/getting-started.md
      - Core concepts: mechdsl-core/concepts.md
      - LaTeX directive reference: mechdsl-core/latex-directives.md
      - Constitutive models: mechdsl-core/constitutive-models.md
      - Examples gallery: mechdsl-core/examples.md
  - algo2code:
      - Introduction: algo2code/index.md
      - Getting started: algo2code/getting-started.md
      - Usage: algo2code/usage.md
      - Examples: algo2code/examples.md
  - ti-runtime:
      - Introduction: ti-runtime/index.md
  - Workbench:
      - Browser workbench: workbench.md
  - Reference:
      - How it works: reference/architecture.md
      - FAQ & troubleshooting: reference/faq.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/CEmM2/MechDSL
      name: MechDSL on GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/mechdsl-core/
      name: mechdsl-core on PyPI
    - icon: fontawesome/solid/flask
      link: https://sosovski.group/
      name: The research group site