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