e-inkunabula/mkdocs.yml at master · Dioscorides/e-inkunabula · 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
## Project information
site_name: E-Inkunabula
site_url: https://github.com/Dioscorides/e-inkunabula
site_description: A repository for creating a custom Home Assistant dashboard on an e-ink display.

## Repository
repo_name: e-inkunabula
repo_url: https://github.com/Dioscorides/e-inkunabula
edit_uri: ''  #disables edit button

## Configuration
theme:
  icon:
    repo: fontawesome/brands/github
  name: material
  #logo: assets/images/logo.svg
  #favicon: assets/images/favicon.png
  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.sections
    - navigation.tracking
    - toc.follow
    - navigation.top
    - navigation.footer
    - content.code.copy

markdown_extensions:
  - admonition
  - attr_list
  - abbr
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - footnotes

nav:
  - Home: index.md
  - Getting started:
    - Requirements: requirements.md
    - Installation: installation.md


## Social Media
extra:
  social:
    - icon: fontawesome/solid/house
      link: https://giuliomenna.net/
    - icon: fontawesome/brands/github-alt
      link: https://github.com/Dioscorides
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.

copyright: GNU General Public License v3.0; Giulio Menna –
  <a href="#__consent">Change cookie settings</a>