aboutsummaryrefslogtreecommitdiffhomepage
path: root/mkdocs.yml
blob: 6b123696c884d58698f5b9973b6c8811035dca74 (plain) (blame)
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
# Project information
site_name: Homer
site_url: https://bastienwirtz.github.io/

# Repository
repo_name: bastienwirtz/homer
repo_url: https://github.com/bastienwirtz/homer
edit_uri: ""

# Custom CSS
extra_css:
  - stylesheets/open-props.1.3.16.min.css
  - stylesheets/styles.css

# Theme
theme:
  favicon: images/logo.png
  logo: images/logo.png
  name: material
  # custom_dir: docs/overrides/
  icon:
    repo: fontawesome/brands/github
  language: en
  palette:
    - media: "(prefers-color-scheme: light)" 
      scheme: default
      toggle:
        icon: fontawesome/solid/sun
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)" 
      scheme: slate
      toggle:
        icon: fontawesome/solid/moon
        name: Switch to light mode
  features:
    - content.code.annotate
    - navigation.indexes
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true

# Copyright - name for footer text
copyright: Homer

# Socials
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/bastienwirtz/homer
    - icon: fontawesome/brands/gitter
      link: https://gitter.im/homer-dashboard/community
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/b4bz/homer

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

# Page tree
nav:
  - What is Homer: index.md
  - Getting started: getting_started.md
  - Configuration: configuration.md
  - Custom services: custom_services.md
  - Tips & tricks: tips_and_tricks.md
  - Development: development.md
  - Troubleshooting: troubleshooting.md