EdgeFEM/mkdocs.yml at main · jman4162/EdgeFEM · 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
site_name: EdgeFEM Documentation
site_description: 3D Finite-Element Electromagnetics Simulator for RF/mmWave
site_author: John Hodge
repo_url: https://github.com/jman4162/EdgeFEM
repo_name: jman4162/EdgeFEM

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - content.code.copy
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Getting Started:
    - Installation: installation.md
    - Quick Start: quickstart.md
  - Tutorials:
    - Rectangular Waveguide: tutorials/waveguide.md
    - Patch Antenna: tutorials/patch_antenna.md
    - Unit Cell Analysis: tutorials/unit_cell.md
  - API Reference:
    - Core Functions: api/core.md
    - Design Classes: api/designs.md
    - Plotting: api/plots.md
  - Validation: validation.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.arithmatex:
      generic: true
  - tables
  - attr_list
  - md_in_html

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

plugins:
  - search