From a2f2e527fbee0fb2bcf3e0d7ae0654c737979352 Mon Sep 17 00:00:00 2001 From: Evan Steinkerchner Date: Fri, 22 Apr 2022 20:47:15 -0400 Subject: [PATCH] Added some content to intro page, renamed files for consistency --- .../{customservices.md => custom_services.md} | 0 docs/index.md | 22 ++++++++++++++----- ...{tips-and-tricks.md => tips_and_tricks.md} | 0 mkdocs.yml | 4 ++-- 4 files changed, 19 insertions(+), 7 deletions(-) rename docs/{customservices.md => custom_services.md} (100%) rename docs/{tips-and-tricks.md => tips_and_tricks.md} (100%) diff --git a/docs/customservices.md b/docs/custom_services.md similarity index 100% rename from docs/customservices.md rename to docs/custom_services.md diff --git a/docs/index.md b/docs/index.md index 460a340..8ae670a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,20 @@ -Homer is web-based dashboard that simplifies your home page management. It is -built with [Vue](https://vuejs.org/) and uses `yaml` configuration files to -provide you with a home page that is dead simple to build and run! +## High-level overview + +Homer is web-based dashboard that simplifies your home page management. Designed +for home labs, corporate internal networks, and anyone looking to organize their +web-based work. It is built with [Vue](https://vuejs.org/) and uses `yaml` +configuration files to provide you with a home page that is dead simple to build +and serve! + +## Ease of use & customizability + +[Get up and running](/getting_started) in seconds using Docker and customize to +your hearts content using the long list of [configuration](/configuration) +options available! Add links to all your relevant services and web apps, +categorize them in groups, and in some cases, +[get live status data](/custom_services) right there on your home page. Customize +your home page with your own images and CSS to make it fit your style! + -Homer gives you the ability to customize content, styles, and even some behavior -through a deep configuration system. diff --git a/docs/tips-and-tricks.md b/docs/tips_and_tricks.md similarity index 100% rename from docs/tips-and-tricks.md rename to docs/tips_and_tricks.md diff --git a/mkdocs.yml b/mkdocs.yml index a30e647..6b12369 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -81,7 +81,7 @@ nav: - What is Homer: index.md - Getting started: getting_started.md - Configuration: configuration.md - - Custom services: customservices.md - - Tips & tricks: tips-and-tricks.md + - Custom services: custom_services.md + - Tips & tricks: tips_and_tricks.md - Development: development.md - Troubleshooting: troubleshooting.md -- 2.41.0