mkdocs.yml

   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   icon:
  19     repo: fontawesome/brands/github
  20   palette:
  21     - media: "(prefers-color-scheme: light)"
  22       scheme: default
  23       primary: blue
  24       accent: blue
  25       toggle:
  26         icon: material/brightness-4
  27         name: Switch to dark mode
  28     - media: "(prefers-color-scheme: dark)"
  29       scheme: slate
  30       primary: blue
  31       accent: blue
  32       toggle:
  33         icon: material/brightness-7
  34         name: Switch to light mode
  35   features:
  36     - content.code.annotate
  37     - navigation.indexes
  38     - navigation.sections
  39     - navigation.top
  40     - navigation.tracking
  41     - search.highlight
  42     - search.share
  43     - search.suggest
  44     - toc.follow
  45
  46 # Copyright - name for footer text
  47 copyright: Homer dashboard
  48
  49 # Socials
  50 extra:
  51   social:
  52     - icon: fontawesome/brands/github
  53       link: https://github.com/bastienwirtz/homer
  54     - icon: fontawesome/brands/gitter
  55       link: https://gitter.im/homer-dashboard/community
  56     - icon: fontawesome/brands/docker
  57       link: https://hub.docker.com/r/b4bz/homer
  58
  59 # Extensions
  60 markdown_extensions:
  61   - abbr
  62   - admonition
  63   - attr_list
  64   - def_list
  65   - footnotes
  66   - meta
  67   - md_in_html
  68   - toc:
  69       permalink: true
  70   - pymdownx.highlight:
  71       anchor_linenums: true
  72   - pymdownx.inlinehilite
  73   - pymdownx.snippets
  74   - pymdownx.superfences
  75
  76 # Page tree
  77 nav:
  78   - Home: index.md
  79   - Configuration: configuration.md
  80   - Custom services: customservices.md
  81   - Tips & tricks: tips-and-tricks.md
  82   - Development: development.md
  83   - Troubleshooting: troubleshooting.md