leanSpec/mkdocs.yml at main · leanEthereum/leanSpec · 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
site_name: Lean Ethereum Specifications
site_description: Reference implementations of the Lean Ethereum protocol
site_author: Ethereum Foundation
site_url: https://leanethereum.github.io/leanSpec/

repo_name: leanEthereum/leanSpec
repo_url: https://github.com/leanEthereum/leanSpec
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_signature_annotations: true
            show_if_no_docstring: false
            inherited_members: true
            members_order: source
            separate_signature: true
            filters: ["!^_"]
            docstring_section_style: google

markdown_extensions:
  - admonition
  - codehilite
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.details
  - toc:
      permalink: true

nav:
  - Home: index.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/leanEthereum/leanSpec

copyright: |
  &copy; 2025 Ethereum Foundation