diff options
| author | Evan Steinkerchner <esteinkerchner@gmail.com> | 2022-03-20 20:19:49 -0400 |
|---|---|---|
| committer | Evan Steinkerchner <esteinkerchner@gmail.com> | 2022-03-20 20:19:49 -0400 |
| commit | 717894d8c53c0f55ab7e70e9dea6002751c1605d (patch) | |
| tree | 34b428f94566dba8b981481f924989351989dc73 /mkdocs.yml | |
| parent | a2dfffab6892c6976fc8b880f75c314506259675 (diff) | |
| download | homer-717894d8c53c0f55ab7e70e9dea6002751c1605d.tar.gz homer-717894d8c53c0f55ab7e70e9dea6002751c1605d.tar.zst homer-717894d8c53c0f55ab7e70e9dea6002751c1605d.zip | |
Initial draft of new docs UI usuing MkDocs
Diffstat (limited to 'mkdocs.yml')
| -rw-r--r-- | mkdocs.yml | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..58e37c3 --- /dev/null +++ b/mkdocs.yml | |||
| @@ -0,0 +1,81 @@ | |||
| 1 | # Project information | ||
| 2 | site_name: Homer | ||
| 3 | site_url: https://bastienwirtz.github.io/homer/ | ||
| 4 | |||
| 5 | # Repository | ||
| 6 | repo_name: bastienwirtz/homer | ||
| 7 | repo_url: https://github.com/bastienwirtz/homer | ||
| 8 | edit_uri: "" | ||
| 9 | |||
| 10 | # Stylesheet | ||
| 11 | extra_css: | ||
| 12 | - stylesheets/styles.css | ||
| 13 | |||
| 14 | # Theme | ||
| 15 | theme: | ||
| 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 | ||
| 45 | copyright: Homer dashboard | ||
| 46 | |||
| 47 | # Socials | ||
| 48 | extra: | ||
| 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 | ||
| 58 | markdown_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 | ||
| 75 | nav: | ||
| 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 | ||