From f7cc9761e994b1820a806e31b76b76b3d519f799 Mon Sep 17 00:00:00 2001 From: Bastien Wirtz Date: Wed, 6 Nov 2024 13:56:12 +0100 Subject: [PATCH] doc: add lemmy and dashboard icons links, cleanup --- README.md | 11 ++++----- docs/customservices.md | 2 +- docs/tips-and-tricks.md | 6 +++++ public/assets/config-demo.yml.dist | 17 ++++++++++++-- public/assets/config.yml.dist | 37 ++++++++++++++++++++---------- 5 files changed, 51 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 31e8151..c628f04 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,6 @@ License: Apache 2 - Gitter chat Download homer static build @@ -58,10 +55,10 @@ - 📂 Multi pages & item grouping - 🎨 Theme customization - ⌨️ keyboard shortcuts: - - `/` Start searching. - - `Escape` Stop searching. - - `Enter` Open the first matching result (respects the bookmark's `_target` property). - - `Alt`/`Option` + `Enter` Open the first matching result in a new tab. + - / Start searching. + - Escape Stop searching. + - Enter Open the first matching result (respects the bookmark's `_target` property). + - Alt (or Option) + Enter Open the first matching result in a new tab. ## Get started diff --git a/docs/customservices.md b/docs/customservices.md index 0d53e91..3c52191 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -152,7 +152,7 @@ For Ping you need to set the type to Ping and provide a url. By default the HEAD type: Ping logo: "assets/tools/sample.png" tag: "app" - url: "https://www.reddit.com/r/selfhosted/" + url: "https://www.wikipedia.org/" method: "head" subtitle: "Bookmark example" # showRtt: true diff --git a/docs/tips-and-tricks.md b/docs/tips-and-tricks.md index 9464b62..992bc0e 100644 --- a/docs/tips-and-tricks.md +++ b/docs/tips-and-tricks.md @@ -2,6 +2,12 @@ Here is a collection of neat tips and tricks that Homer users have come up with! +## Dashboard icons + +Great source to find service icons + +- + ## Use Homer as a custom "new tab" page #### `by @vosdev` diff --git a/public/assets/config-demo.yml.dist b/public/assets/config-demo.yml.dist index 8a4b22e..283be7f 100644 --- a/public/assets/config-demo.yml.dist +++ b/public/assets/config-demo.yml.dist @@ -67,12 +67,18 @@ services: subtitle: "Displays dynamic information or actions." tag: "setup" url: "https://github.com/bastienwirtz/homer/blob/main/docs/theming.md" + - name: "Dashboard icons" + icon: "fa-solid fa-icons" + subtitle: "Dashboard icons" + tag: "setup" + url: "https://github.com/walkxcode/dashboard-icons" - name: "Buy me a coffee!" subtitle: "Sponsor this project" icon: "fa-solid fa-mug-hot" url: "https://www.buymeacoffee.com/bastien" - name: "Smart cards showcase" icon: "fa-solid fa-brain" + class: "highlight-purple" items: - name: "Octoprint" logo: "https://cdn-icons-png.flaticon.com/512/3112/3112529.png" @@ -102,12 +108,19 @@ services: type: "OpenWeather" - name: "Ressources" icon: "fa-regular fa-bookmark" + class: highlight-inverted items: - name: "r/selfhosted" icon: "fa-brands fa-reddit-alien" - subtitle: "Bookmark example" - tag: "reddit" + subtitle: "selfhosted community on Reddit" + tag: "community" url: "https://www.reddit.com/r/selfhosted/" + target: "_blank" + - name: "c/selfhosted" + logo: "https://icons.iconarchive.com/icons/simpleicons-team/simple/256/lemmy-icon.png" + subtitle: "selfhosted community on Lemmy" + tag: "community" + url: "https://lemmy.world/c/selfhosted" target: "_blank" - name: "Awesome selfhosted" icon: "fa-solid fa-star" diff --git a/public/assets/config.yml.dist b/public/assets/config.yml.dist index 58a03ac..f7dae53 100644 --- a/public/assets/config.yml.dist +++ b/public/assets/config.yml.dist @@ -74,15 +74,28 @@ services: - name: "Applications" icon: "fas fa-cloud" items: - - name: "Awesome app" - logo: "assets/tools/sample.png" - subtitle: "Bookmark example" - tag: "app" - keywords: "self hosted reddit" - url: "https://www.reddit.com/r/selfhosted/" - target: "_blank" # optional html a tag target attribute - - name: "Another one" - logo: "assets/tools/sample2.png" - subtitle: "Another application" - tag: "app" - url: "#" + - name: "Get started" + icon: "fa-solid fa-download" + subtitle: "Start using Homer in a few minutes" + tag: "setup" + url: "https://github.com/bastienwirtz/homer?tab=readme-ov-file#getting-started" + - name: "Configuration" + icon: "fa-solid fa-sliders" + subtitle: "Configuration options documentation" + tag: "setup" + url: "https://github.com/bastienwirtz/homer/blob/main/docs/configuration.md" + - name: "Theming" + icon: "fa-solid fa-palette" + subtitle: "Customize Homer appearance" + tag: "theming" + url: "https://github.com/bastienwirtz/homer/blob/main/docs/theming.md" + - name: "Smart cards" + icon: "fa-solid fa-palette" + subtitle: "Displays dynamic information or actions." + tag: "setup" + url: "https://github.com/bastienwirtz/homer/blob/main/docs/theming.md" + - name: "Dashboard icons" + icon: "fa-solid fa-icons" + subtitle: "Dashboard icons" + tag: "setup" + url: "https://github.com/walkxcode/dashboard-icons"