]> git.immae.eu Git - github/bastienwirtz/homer.git/blob - docs/index.md
Added 'Features' section from README to docs
[github/bastienwirtz/homer.git] / docs / index.md
1 <img class="hero-image" src="images/screenshot.png" draggable="false" />
2
3 ## High-level overview
4
5 Homer is web-based dashboard that simplifies your home page management. Designed
6 for home labs, corporate internal networks, and anyone looking to organize their
7 web-based work. It is built with [Vue](https://vuejs.org/) and uses `yaml`
8 configuration files to provide you with a home page that is dead simple to build
9 and serve!
10
11 ## Ease of use & customizability
12
13 [Get up and running](/getting_started) in seconds using Docker and customize to
14 your hearts content using the long list of [configuration](/configuration)
15 options available! Add links to all your relevant services and web apps,
16 categorize them in groups, and in some cases,
17 [get live status data](/custom_services) right there on your home page.
18 Customize your home page with your own images and CSS to make it fit your style!
19
20 ## Features
21
22 - [yaml](http://yaml.org/) file configuration
23 - Installable (pwa)
24 - Search
25 - Grouping
26 - Theme customization
27 - Offline health check
28 - keyboard shortcuts:
29 - `/` Start searching.
30 - `Escape` Stop searching.
31 - `Enter` Open the first matching result (respects the bookmark's `_target` property).
32 - `Alt`/`Option` + `Enter` Open the first matching result in a new tab.
33
34