aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorkamtschatka <sschatka@gmail.com>2024-05-25 23:20:17 +0200
committerGitHub <noreply@github.com>2024-05-25 22:20:17 +0100
commit033e8a2d26bb0ecaa8301609960d35d3467a88f4 (patch)
tree8c899a081b1cdd31eb24ab851b7a5c9d1dec858e /docs
parentbb431be02850ca37f89cc40ce958226f64fe5ad5 (diff)
downloadkarakeep-033e8a2d26bb0ecaa8301609960d35d3467a88f4.tar.zst
feature: Allow import Netscape HTML format (#163)
* [Feature request] Netscape HTML format import/export #96 added the possibility to add exported bookmarks via the webUI for ease of use * [Feature request] Netscape HTML format import/export #96 updated the documentation * Extract the parser into its own file and reuse the existing bookmark upload logic --------- Co-authored-by: kamtschatka <simon.schatka@gmx.at> Co-authored-by: MohamedBassem <me@mbassem.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/10-import.md33
1 files changed, 25 insertions, 8 deletions
diff --git a/docs/docs/10-import.md b/docs/docs/10-import.md
index f0e6ee35..14c59034 100644
--- a/docs/docs/10-import.md
+++ b/docs/docs/10-import.md
@@ -1,28 +1,45 @@
# Importing Bookmarks
+## Import using the WebUI
+
+Hoarder supports importing bookmarks using the Netscape HTML Format.
+
+Simply open the WebUI of your Hoarder instance and drag and drop the bookmarks file into the UI.
+
+:::info
+All the URLs in the bookmarks file will be added automatically, you will not be able to pick and choose which bookmarks to import!
+:::
+
+## Import using the CLI
+
:::warning
-Currently importing bookmarks requires some technical knowledge and might not be very straightforward for non-technical users. Don't hesitate to ask questions in github discussions or discord though.
+Importing bookmarks using the CLI requires some technical knowledge and might not be very straightforward for non-technical users. Don't hesitate to ask questions in github discussions or discord though.
:::
-## Import from Chrome
+### Import from Chrome
-- Open Chrome and go to `chrome://bookmarks`
-- Click on the three dots on the top right corner and choose `Export bookmarks`
-- This will download an html file with all of your bookmarks.
+- First follow the steps below to export your bookmarks from Chrome
- To extract the links from this html file, you can run this simple bash one liner (if on windows, you might need to use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install)): `cat <file_path> | grep HREF | sed 's/.*HREF="\([^"]*\)".*/\1/' > all_links.txt`.
- This will create a file `all_links.txt` with all of your bookmarks one per line.
- To import them, we'll use the [hoarder cli](https://docs.hoarder.app/command-line). You'll need a Hoarder API key for that.
-
-Run the following command to import all the links from `all_links.txt`:
+- Run the following command to import all the links from `all_links.txt`:
```
cat all_links.txt | xargs -I{} hoarder --api-key <key> --server-addr <addr> bookmarks add --link {}
```
-## Import from other platforms
+### Import from other platforms
If you can get your bookmarks in a text file with one link per line, you can use the following command to import them using the [hoarder cli](https://docs.hoarder.app/command-line):
```
cat all_links.txt | xargs -I{} hoarder --api-key <key> --server-addr <addr> bookmarks add --link {}
```
+
+## Exporting Bookmarks from Chrome
+
+- Open Chrome and go to `chrome://bookmarks`
+- Click on the three dots on the top right corner and choose `Export bookmarks`
+- This will download an html file with all of your bookmarks.
+
+You can use this file to import the bookmarks using the UI or CLI method described above \ No newline at end of file