marcel/linkding
1
0
Fork 0
mirror of https://github.com/sissbruecker/linkding.git synced 2025-08-06 18:38:31 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add docs for auto tagging (#1009)

Browse Source
This commit is contained in:
Sascha Ißbrücker
2025-03-08 09:20:35 +01:00
committed by GitHub
parent 6838e45e99
commit 996e2b6e19
2 changed files with 56 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/astro.config.mjs
View File

@@ -28,6 +28,7 @@ export default defineConfig({
items: [
{ label: 'Backups', slug: 'backups' },
{ label: 'Archiving', slug: 'archiving' },
{ label: 'Auto Tagging', slug: 'auto-tagging' },
{ label: 'Keyboard Shortcuts', slug: 'shortcuts' },
{ label: 'How To', slug: 'how-to' },
{ label: 'Troubleshooting', slug: 'troubleshooting' },

55
docs/src/content/docs/auto-tagging.md Normal file
View File

@@ -0,0 +1,55 @@
---
title: "Auto tagging"
description: "How to automatically assign tags to bookmarks based on predefined rules"
---
Auto tagging allows to automatically add tags to bookmarks based on predefined rules. This makes categorizing commonly
bookmarked websites easier and faster.
Auto tagging rules can be defined in the profile settings. Each rule maps a URL pattern to one or more tags. For
example:
```
youtube.com video
reddit.com/r/Music music reddit
```
When a bookmark is created or updated, the URL of the bookmark is parsed to extract the hostname, path, and query
string. These components are then compared against the patterns defined in the auto tagging rules. If all components
match, the tags associated with the rule are added to the bookmark. Both the bookmark form in the web interface and the
browser extension will show a preview of the tags that will be added based on the auto tagging rules.
The URL matching works like this:
- **Hostname Matching**: The hostname of the bookmark URL is compared to the hostname in the rule. If the rule does not
specify a subdomain, it matches all subdomains. For example, a rule with `youtube.com` will match both
`www.youtube.com` and `m.youtube.com`. If a subdomain is specified in the rule, it will only match that subdomain. For
example, a rule with `gist.github.com` will only match `gist.github.com`.
- **Path Matching**: The path of the bookmark URL is compared to the path in the rule. If the rule does not specify a
path, it matches all paths. For example, a rule with `reddit.com` will match `reddit.com/r/music`,
`reddit.com/r/gaming`, etc. If a path is specified in the rule, it will only match that path and all its subpaths. For
example, a rule with `reddit.com/r/music` will match `reddit.com/r/music`, `reddit.com/r/music/new`, etc.
- **Query String Matching**: The query string parameters of the bookmark URL are compared to those in the rule. If the
rule does not specify any query string parameters, it matches all query strings. If the rule specifies a query string
it will only match if the bookmark URL contains all the specified query string parameters with their respective
values.
Note that URL matching currently does not support any kind of wildcards. Rule matching only works based on the URL, not
on the content of the website or any other aspect of the bookmark.
## Example
Consider the following auto tagging rule:
```
reddit.com/r/Music music reddit
```
When adding a bookmark for a URL like `https://www.reddit.com/r/Music/comments/...`, the auto tagging mechanism will:
1. Parse the URL to extract the hostname (`www.reddit.com`), path (`/r/Music/comments/...`), and query string (none).
2. Match the hostname against the pattern. The domain `reddit.com` matches. Since the rule does not specify a subdomain,
it also matches `www.reddit.com`.
3. Match the path against the pattern. The path `/r/Music` also matches the nested path `/r/Music/comments/...`.
4. Match the query string. Since the rule does not specify a query string, it matches all query strings.
5. The tags `music` and `reddit` will be added to the bookmark.