IMAS-Standard-Names/mkdocs.yml at main · iterorganization/IMAS-Standard-Names · 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: "Fusion Conventions: Standard Names"
site_url:
  !ENV [SITE_URL, "https://iterorganization.github.io/IMAS-Standard-Names/"]

plugins:
  - include-markdown
  - macros:
      verbose: true
      modules:
        - docs.grammar_macros
  - search
  - table-reader
  - mike:
      canonical_version: latest
      version_selector: true
      css_dir: stylesheets
      javascript_dir: javascripts

watch:
  - imas_standard_names/grammar/specification.yml
  - imas_standard_names/grammar/vocabularies/
  - docs/grammar_macros.py

nav:
  - Home: index.md
  - Catalog: catalog.md
  - Grammar Reference: grammar-reference.md
  - Guidelines: guidelines.md
  - Development:
    - Quick Start: development/quickstart.md
    - Style Guide: development/style-guide.md
    - Specification: development/specification.md
    - Provenance: development/provenance.md
    - Reductions: development/reductions.md
    - Contributing: development/contributing.md

theme:
  name: material
  features:
    # - navigation.instant  # Temporarily disabled for testing
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.top

extra:
  version:
    provider: mike

# Enable latex/math notation
markdown_extensions:
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - attr_list

extra_css:
  - stylesheets/catalog.css

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
  - javascripts/anchor-scroll.js