aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.30.0/05-integrations
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/versioned_docs/version-v0.30.0/05-integrations/02-command-line.md (renamed from docs/versioned_docs/version-v0.25.0/09-command-line.md)2
-rw-r--r--docs/versioned_docs/version-v0.30.0/05-integrations/03-mcp.md (renamed from docs/versioned_docs/version-v0.24.0/09-mcp.md)0
-rw-r--r--docs/versioned_docs/version-v0.30.0/05-integrations/05-singlefile.md (renamed from docs/versioned_docs/version-v0.25.0/14-Guides/03-singlefile.md)0
-rw-r--r--docs/versioned_docs/version-v0.30.0/05-integrations/06-rss-feeds.md50
-rw-r--r--docs/versioned_docs/version-v0.30.0/05-integrations/_category_.json4
5 files changed, 55 insertions, 1 deletions
diff --git a/docs/versioned_docs/version-v0.25.0/09-command-line.md b/docs/versioned_docs/version-v0.30.0/05-integrations/02-command-line.md
index a86fa61e..c8b00696 100644
--- a/docs/versioned_docs/version-v0.25.0/09-command-line.md
+++ b/docs/versioned_docs/version-v0.30.0/05-integrations/02-command-line.md
@@ -89,7 +89,7 @@ Commands:
help [command] display help for command
```
-## Optaining an API Key
+## Obtaining an API Key
To use the CLI, you'll need to get an API key from your karakeep settings. You can validate that it's working by running:
diff --git a/docs/versioned_docs/version-v0.24.0/09-mcp.md b/docs/versioned_docs/version-v0.30.0/05-integrations/03-mcp.md
index 514332de..514332de 100644
--- a/docs/versioned_docs/version-v0.24.0/09-mcp.md
+++ b/docs/versioned_docs/version-v0.30.0/05-integrations/03-mcp.md
diff --git a/docs/versioned_docs/version-v0.25.0/14-Guides/03-singlefile.md b/docs/versioned_docs/version-v0.30.0/05-integrations/05-singlefile.md
index c0f4e174..c0f4e174 100644
--- a/docs/versioned_docs/version-v0.25.0/14-Guides/03-singlefile.md
+++ b/docs/versioned_docs/version-v0.30.0/05-integrations/05-singlefile.md
diff --git a/docs/versioned_docs/version-v0.30.0/05-integrations/06-rss-feeds.md b/docs/versioned_docs/version-v0.30.0/05-integrations/06-rss-feeds.md
new file mode 100644
index 00000000..e633813c
--- /dev/null
+++ b/docs/versioned_docs/version-v0.30.0/05-integrations/06-rss-feeds.md
@@ -0,0 +1,50 @@
+# RSS Feeds
+
+Karakeep offers RSS feed integration, allowing you to both consume RSS feeds from external sources and publish your lists as RSS feeds for others to subscribe to.
+
+## Publishing RSS Feeds
+
+You can publish any of your lists as an RSS feed, making it easy to share your bookmarks with others or integrate them into RSS readers.
+
+### Enabling RSS for a List
+
+1. Navigate to one of your lists
+2. Click on the list settings (three dots menu)
+3. Toggle the "RSS Feed" switch to enable it
+4. Copy the generated RSS feed URL
+
+### What Gets Published
+
+RSS feeds include:
+- **Links**: Bookmarks of type "link" with their URL, title, description, and author
+- **Assets**: Uploaded files (PDFs, images) are included with a link to view them
+- **Tags**: Bookmark tags are exported as RSS categories
+- **Dates**: The bookmark creation date is used as the publication date
+
+Note: Text notes are not included in RSS feeds as they don't have an associated URL.
+
+### Security Considerations
+
+- Each RSS feed requires a unique token for access
+- Tokens can be regenerated at any time, which will invalidate the old URL
+- Disabling RSS for a list immediately revokes access
+
+## Consuming RSS Feeds
+
+Karakeep can automatically monitor RSS feeds and create bookmarks from new entries, making it perfect for staying up to date with blogs, news sites, and other content sources.
+
+### Adding an RSS Feed
+
+1. Go to **Settings** → **RSS Feeds**
+2. Click **Add Feed**
+3. Enter the feed details:
+ - **Name**: A friendly name for the feed
+ - **URL**: The RSS/Atom feed URL
+ - **Enabled**: Toggle to enable/disable the feed
+ - **Import Tags**: Enable to import RSS categories as bookmark tags
+
+### How It Works
+
+- Karakeep checks enabled RSS feeds **every hour**
+- New entries are automatically created as bookmarks
+- Duplicate entries are automatically detected and skipped
diff --git a/docs/versioned_docs/version-v0.30.0/05-integrations/_category_.json b/docs/versioned_docs/version-v0.30.0/05-integrations/_category_.json
new file mode 100644
index 00000000..c2495ffd
--- /dev/null
+++ b/docs/versioned_docs/version-v0.30.0/05-integrations/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Integrations",
+ "position": 5
+}