Skip to content

Commit

Permalink
doc: add lemmy and dashboard icons links, cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
bastienwirtz committed Nov 6, 2024
1 parent aa8be8e commit 339601d
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 22 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@
<a href="https://opensource.org/licenses/Apache-2.0"><img
alt="License: Apache 2"
src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
<a href="https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge"><img
alt="Gitter chat"
src="https://badges.gitter.im/homer-dashboard/community.svg"></a>
<a href="https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip"><img
alt="Download homer static build"
src="https://img.shields.io/badge/Download-homer.zip-orange"></a>
Expand Down Expand Up @@ -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.
- <kbd>/</kbd> Start searching.
- <kbd>Escape</kbd> Stop searching.
- <kbd>Enter</kbd> Open the first matching result (respects the bookmark's `_target` property).
- <kbd>Alt</kbd> (or <kbd>Option</kbd>) + <kbd>Enter</kbd> Open the first matching result in a new tab.

## Get started

Expand Down
2 changes: 1 addition & 1 deletion docs/customservices.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
17 changes: 15 additions & 2 deletions public/assets/config-demo.yml.dist
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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"
Expand Down
37 changes: 25 additions & 12 deletions public/assets/config.yml.dist
Original file line number Diff line number Diff line change
Expand Up @@ -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"

0 comments on commit 339601d

Please sign in to comment.