Karl/homepage
1
0
Fork 0
mirror of https://github.com/karl0ss/homepage.git synced 2025-04-29 12:03:41 +01:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: improve bookmarks documentation and working examples (#2713)

Browse Source
This commit is contained in:
Mark Lavi 2024-01-20 20:35:54 -06:00 committed by GitHub
parent e206c86de8
commit 44b161799b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/configs/bookmarks.md
View File

@ -3,7 +3,7 @@ title: Bookmarks
description: Bookmark Configuration description: Bookmark Configuration
--- ---
Bookmarks function much the same as [Services](services.md), in how groups and lists work. They're just much simpler, smaller, and contain no extra features other than being a link out. Bookmarks are configured in the `bookmarks.yaml` file. They function much the same as [Services](services.md), in how groups and lists work. They're just much simpler, smaller, and contain no extra features other than being a link out.
The design of homepage expects `abbr` to be 2 letters, but is not otherwise forced. The design of homepage expects `abbr` to be 2 letters, but is not otherwise forced.
@ -12,6 +12,7 @@ You can also use an icon for bookmarks similar to the [options for service icons
By default, the description will use the hostname of the link, but you can override it with a custom description. By default, the description will use the hostname of the link, but you can override it with a custom description.
```yaml ```yaml
---
- Developer: - Developer:
- Github: - Github:
- abbr: GH - abbr: GH
@ -29,4 +30,8 @@ By default, the description will use the hostname of the link, but you can overr
href: https://youtube.com/ href: https://youtube.com/
``` ```
which renders to (depending on your theme, etc.):
<img width="1000" alt="Bookmarks" src="https://user-images.githubusercontent.com/19408/269307009-d7e45885-230f-4e07-b421-9822017ae878.png"> <img width="1000" alt="Bookmarks" src="https://user-images.githubusercontent.com/19408/269307009-d7e45885-230f-4e07-b421-9822017ae878.png">
The default [bookmarks.yaml](https://github.com/gethomepage/homepage/blob/main/src/skeleton/bookmarks.yaml) is a working example.