diff --git a/docs/configs/bookmarks.md b/docs/configs/bookmarks.md index 27f6c2737..897975e2a 100644 --- a/docs/configs/bookmarks.md +++ b/docs/configs/bookmarks.md @@ -3,7 +3,7 @@ title: Bookmarks 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. @@ -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. ```yaml +--- - Developer: - Github: - 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/ ``` +which renders to (depending on your theme, etc.): + Bookmarks + +The default [bookmarks.yaml](https://github.com/gethomepage/homepage/blob/main/src/skeleton/bookmarks.yaml) is a working example.