wildmeshing.github.io/mkdocs.yml at doc · wildmeshing/wildmeshing.github.io · 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
site_name: Fast robust meshing
site_url: "https://wildmeshing.github.io/"
repo_name: "wildmeshing"
repo_url: "https://github.com/wildmeshing/wildmeshing-toolkit"
edit_uri: "../https://github.com/wildmeshing/wildmeshing-toolkit/edit/doc/doc/"
site_description: "Fast robust meshing"
# strict: true
docs_dir: "doc"
remote_branch: "main"
theme:
  name: material
  custom_dir: "doc/theme"
  favicon: "favicon.ico"
  icon:
    logo: material/library
    repo: fontawesome/brands/github
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: "cyan"
      accent: "indigo"
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: "blue"
      accent: "deep purple"
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.expand
    - search.suggest
    - search.highlight
extra:
  social:
    - icon: fontawesome/brands/github
      link: "https://github.com/wildmeshing/wildmeshing-toolkit"
extra_css:
  - theme/extra.css
markdown_extensions:
  - codehilite
  - footnotes
  - admonition
  - toc:
      permalink: true
  - markdown.extensions.smarty
  - markdown.extensions.toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.magiclink:
      repo_url_shorthand: true
      repo_url_shortener: true
      user: wildmeshing
      repo: wildmeshing
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.extra
  - pymdownx.tabbed:
      alternate_style: true
plugins:
  # - mknotebooks:
  #     execute: true
  #     preamble: "doc/plot_to_md.py"
  #     timeout: -1
  - git-revision-date
  - search
  # - mkdocs-jupyter:
  #     ignore_h1_titles: True
  #     include_source: True
  - include-markdown
extra_javascript:
  - js/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
nav:
  - Home: index.md
  - Wildmeshing:
      - Home: wildmeshing.md
      - Shortest Edge Collapse: toolkit_specs/shortest_edge_collapse_spec.md
      - QSLIM: toolkit_specs/qslim_spec.md
      - Isotropic Remeshing: toolkit_specs/isotropic_remeshing_spec.md
      - TetWild: toolkit_specs/tetwild_spec.md
      - TriWild: toolkit_specs/triwild_spec.md
      - SimWild: toolkit_specs/simwild_spec.md
      - Topological Offset: toolkit_specs/topological_offset_spec.md
      - Manifold Extraction: toolkit_specs/manifold_extraction_spec.md
      - Docs: https://wildmeshing.github.io/wildmeshing-toolkit/index.html
  - TetWild: tetwild.md
  - fTetWild: ftetwild.md
  - TriWild: triwild.md
  - Python:
      - Home: python.md
    # - Notebook: wildmeshing-notebook.ipynb