mesa-frames/mkdocs.yml at main · mesa/mesa-frames · 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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# Project information
site_name: mesa-frames documentation
site_url: https://mesa.github.io/mesa-frames
repo_url: https://github.com/mesa/mesa-frames
repo_name: mesa/mesa-frames
edit_uri: edit/main/docs/general/
docs_dir: docs/general

# Theme configuration
theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - navigation.indexes
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - header.autohide
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    repo: fontawesome/brands/github
  # Logo (PNG)
  logo: https://raw.githubusercontent.com/mesa/mesa/main/docs/images/mesa_logo.png
  # Favicon (ICO)
  favicon: https://raw.githubusercontent.com/mesa/mesa/main/docs/images/mesa_logo.ico

# Plugins
plugins:
  - search
  - mkdocs-jupyter:
      execute: true
      include: ["*.ipynb"] # Restrict processing to notebooks only (avoid executing raw .py tutorial files)
  - git-revision-date-localized:
      enable_creation_date: true
  - minify:
      minify_html: true
  - include-markdown:
      encoding: utf-8

# Extensions
markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: mesa
      repo: mesa-frames
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Extra JavaScript and CSS for rendering
extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra_css:
  - stylesheets/theme-images.css

# Custom CSS for branding (brand-core then material adapter)
# Customization
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/mesa
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/mesa-frames/

# Navigation
nav:
  - Home: index.md
  - User Guide:
      - Getting Started: user-guide/0_getting-started.md
      - Classes: user-guide/1_classes.md
  - Tutorials:
      - Introductory Tutorial: tutorials/2_introductory_tutorial.ipynb
      - Advanced Tutorial: tutorials/3_advanced_tutorial.ipynb
      - Data Collector Tutorial: tutorials/4_datacollector.ipynb
  - API Reference: api/index.html
  - Contributing:
      - Contribution Guide: contributing.md
      - Roadmap: roadmap.md
      - Changelog: changelog.md