]> git.immae.eu Git - github/bastienwirtz/homer.git/blame - mkdocs.yml
Created new custom home page, moved Getting started to its own page, fixed requiremen...
[github/bastienwirtz/homer.git] / mkdocs.yml
CommitLineData
717894d8
ES
1# Project information
2site_name: Homer
82858235 3site_url: https://bastienwirtz.github.io/
717894d8
ES
4
5# Repository
6repo_name: bastienwirtz/homer
7repo_url: https://github.com/bastienwirtz/homer
8edit_uri: ""
9
717894d8
ES
10# Theme
11theme:
82858235 12 favicon: images/logo.png
717894d8
ES
13 logo: images/logo.png
14 name: material
82858235 15 custom_dir: docs/overrides/
03f2e6bb
ES
16 icon:
17 repo: fontawesome/brands/github
82858235 18 language: en
717894d8
ES
19 palette:
20 - media: "(prefers-color-scheme: light)"
21 scheme: default
22 primary: blue
23 accent: blue
24 toggle:
25 icon: material/brightness-4
26 name: Switch to dark mode
27 - media: "(prefers-color-scheme: dark)"
28 scheme: slate
29 primary: blue
30 accent: blue
31 toggle:
32 icon: material/brightness-7
33 name: Switch to light mode
34 features:
35 - content.code.annotate
36 - navigation.indexes
37 - navigation.sections
38 - navigation.top
39 - navigation.tracking
40 - search.highlight
41 - search.share
42 - search.suggest
43 - toc.follow
82858235
ES
44 # Don't include MkDocs' JavaScript
45 include_search_page: false
46 search_index_only: true
717894d8
ES
47
48# Copyright - name for footer text
49copyright: Homer dashboard
50
51# Socials
52extra:
53 social:
54 - icon: fontawesome/brands/github
55 link: https://github.com/bastienwirtz/homer
56 - icon: fontawesome/brands/gitter
57 link: https://gitter.im/homer-dashboard/community
58 - icon: fontawesome/brands/docker
59 link: https://hub.docker.com/r/b4bz/homer
60
61# Extensions
62markdown_extensions:
63 - abbr
64 - admonition
65 - attr_list
66 - def_list
67 - footnotes
68 - meta
69 - md_in_html
70 - toc:
71 permalink: true
72 - pymdownx.highlight:
73 anchor_linenums: true
74 - pymdownx.inlinehilite
75 - pymdownx.snippets
76 - pymdownx.superfences
77
78# Page tree
79nav:
80 - Home: index.md
82858235 81 - Getting started: getting_started.md
717894d8
ES
82 - Configuration: configuration.md
83 - Custom services: customservices.md
84 - Tips & tricks: tips-and-tricks.md
85 - Development: development.md
86 - Troubleshooting: troubleshooting.md