computational-fields/mkdocs.yml at main · Samuele95/computational-fields · 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
site_name: Computational Fields
site_url: https://samuele95.github.io/computational-fields/
site_description: Interactive simulator for aggregate computing and self-organising programs
site_author: Samuele95
repo_url: https://github.com/Samuele95/computational-fields
repo_name: Samuele95/computational-fields

theme:
  name: material
  palette:
    - scheme: slate
      primary: deep purple
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: deep purple
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - search.highlight
  icon:
    repo: fontawesome/brands/github

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - First Steps: getting-started/first-steps.md
  - Theory:
      - Field Calculus: theory/field-calculus.md
      - Building Blocks: theory/building-blocks.md
      - Self-Stabilisation: theory/self-stabilisation.md
  - API Reference:
      - Core Primitives: api/primitives.md
      - Building Blocks: api/blocks.md
      - Simulation: api/simulation.md
  - Demos:
      - Overview: demos/overview.md
      - Gradient: demos/gradient.md
      - Channel: demos/channel.md
      - Sparse Leaders: demos/sparse-leaders.md
      - Crowd Monitoring: demos/crowd-monitoring.md
  - Deployment: deployment.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.arithmatex:
      generic: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Samuele95/computational-fields