heiplanet-models/mkdocs.yml at main · ssciwr/heiplanet-models · 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
site_name: heiplanet-models
nav:
  - Home: index.md
  - Getting Started: getting_started.md
  - Basic Design: basic_design.md
  - Using existing models: using_existing_models.md
  - Creating new models: create_new_model.md
  - Existing Models:
    - models/jmodel.md
    - models/pmodel.md
  - Notebooks:
    - Example of how to use an existing model: ./sources/model_jmodel_python.ipynb
  - API Reference: api.md
  - Licence: license.md
theme:
  name: material
  #logo: path/to/file.png
  features:
    - announce.dismiss
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tooltips
    - navigation.footer
    - navigation.path
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - search.highlight
    - search.suggest
    - toc.follow
  icon:
    admonition:
      note: material/pencil-circle

plugins:
  - mkdocs-jupyter:
      ignore_h1_titles: True
  - mkdocstrings:
      default_handler: python

markdown_extensions:
  - admonition
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - javascripts/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css