guide/mkdocs.yml at main · eeintech/guide · 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
site_name: "Electronic designs: The guide to good manners"
site_url: https://guide.eeinte.ch/
site_description: "Electronic designs: The guide to good manners"
site_author: eeintech

# Repository
# repo_url: https://github.com/eeintech/guide
# repo_name: eeintech/guide

# Plugins
plugins:
  - search
  - glightbox

# Theme
theme:
  name: material
  custom_dir: _includes/overrides
  logo: assets/logo.png
  favicon: assets/logo.png
  icon:
    repo: fontawesome/brands/github
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.indexes
    - navigation.tabs
    - navigation.footer
    - navigation.top
    - toc.integrate
    - toc.follow

# Navigation
nav:
  - index.md
  - diagram.md
  - review.md
  - The schematics:
    - The component picking: s_pick.md
    - The symbols: s_symbol.md
    - The most intuitive circuits: s_circuit.md
  - The layout:
    - The placement: l_place.md
    - The contraints: l_constraint.md
    - The routing: l_route.md
  - validation.md

copyright: >
  Copyright &copy; 2023 – <a target="_blank" href="https://github.com/eeintech">eeintech</a>

# Extensions
markdown_extensions:
  - toc:
      permalink: true