docs/mkdocs.yml at master · antonpaisov/docs · 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
# Site Information
site_name: ""
site_description: Lightweight documentation for the Calimero network and developer stack
site_url: https://docs.calimero.network

# Repository
repo_url: https://github.com/calimero-network/docs
edit_uri: ""

# Theme Configuration
theme:
  name: material
  logo: assets/img/logo-black.svg
  favicon: assets/img/favicon.svg

  # Color palette with light/dark mode toggle (respects device settings)
  palette:
    # Light mode - automatically selected if device is in light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black        # Calimero's primary brand color (black)
      accent: green         # Calimero's accent color (green)
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Dark mode - automatically selected if device is in dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black        # Consistent black for branding
      accent: green         # Green accent for interactive elements
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  # Font configuration - Tech variant
  font:
    text: IBM Plex Sans    # Modern, tech-focused font for body text
    code: IBM Plex Mono    # Matching monospace font for code blocks

  # To disable Google Fonts and use custom fonts, set:
  # font: false
  # Then add your custom fonts via extra_css (see below)

  # Additional theme features
  features:
    - navigation.instant    # Instant loading (SPA-like)
    - navigation.tracking   # URL updates with scroll position
    - navigation.tabs       # Top-level sections in tabs
    - navigation.tabs.sticky # Keep tabs visible when scrolling
    - navigation.sections   # Show sections in sidebar
    - navigation.indexes    # Allow section index pages
    - navigation.top        # Back to top button
    - search.suggest        # Search suggestions
    - search.highlight      # Highlight search terms
    - content.code.copy     # Copy button for code blocks
    - content.tabs.link     # Link content tabs

# Plugins (install with: pip install <plugin-name>)
plugins:
  - search  # Built-in search functionality

# Custom CSS for branding and logo switching
extra_css:
  - stylesheets/extra.css

# Popular MkDocs Plugins to consider:
# - mkdocs-material (already using as theme)
# - mkdocs-mermaid2-plugin: For diagrams and flowcharts
# - mkdocs-macros-plugin: Variables and macros in markdown
# - mkdocs-git-revision-date-localized-plugin: Show last update dates
# - mkdocs-glightbox: Image zoom and galleries
# - mkdocs-minify-plugin: Minify HTML/CSS/JS
# - mkdocs-redirects: Handle URL redirects
# - mkdocs-awesome-pages-plugin: Better page organization

# Navigation structure
nav:
  - Home: index.md
  - Introduction: intro/index.md
  - App Directory: app-directory/index.md
  - Builder Directory: builder-directory/index.md
  - Tools & APIs: tools-apis/index.md
  - Privacy, Verifiability & Security: privacy-verifiability-security/index.md

# Extra configuration
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/calimero-network/docs
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/CalimeroNetwork
    - icon: fontawesome/solid/globe
      link: https://calimero.network

# Markdown extensions
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3  # Limit TOC to H1, H2, H3 only (not H4, H5, H6)