simplify import instructions

marph91 · Jul 25, 2024 · edc4cb6 · edc4cb6
1 parent 7ffd9fe
commit edc4cb6
Show file tree

Hide file tree

Showing 24 changed files with 207 additions and 149 deletions.
diff --git a/docs/formats/bear.md b/docs/formats/bear.md
@@ -1,10 +1,12 @@
-- [Website](https://bear.app/)
-- Typical extension: `.bear2bk`
+This page describes how to import notes from Bear to Joplin.
 
-## Export Instructions
+## General Information
 
-<https://bear.app/faq/backup-restore/>
+- [Website](https://bear.app/)
+- Typical extension: `.bear2bk`
 
-## Import to Joplin
+## Instructions
 
-Example: `jimmy-cli-linux backup.bear2bk --format bear`
+1. Export as described in <https://bear.app/faq/backup-restore/>
+2. [Install jimmy](../index.md#Installation)
+3. Import to Joplin. Example: `jimmy-cli-linux backup.bear2bk --format bear`
diff --git a/docs/formats/cacher.md b/docs/formats/cacher.md
@@ -1,13 +1,15 @@
-- [Website](https://www.cacher.io/)
-- Typical extension: `.json`
+This page describes how to import notes from Cacher to Joplin.
 
-## Export Instructions
+## General Information
 
-<https://www.cacher.io/docs/guides/snippets/exporting-snippets#how-to-export-1>
+- [Website](https://www.cacher.io/)
+- Typical extension: `.json`
 
-## Import to Joplin
+## Instructions
 
-Example: `jimmy-cli-linux cacher-export-202406182304.json --format cacher`
+1. Export as described in <https://www.cacher.io/docs/guides/snippets/exporting-snippets#how-to-export-1>
+2. [Install jimmy](../index.md#Installation)
+3. Import to Joplin. Example: `jimmy-cli-linux cacher-export-202406182304.json --format cacher`
 
 ## Import Structure
 

diff --git a/docs/formats/cherrytree.md b/docs/formats/cherrytree.md
@@ -1,14 +1,16 @@
-- [Website](https://www.giuspen.net/cherrytree/)
-- Typical extension: `.ctd`
+This page describes how to import notes from CherryTree to Joplin.
 
-## Export Instructions
+## General Information
 
-- <https://www.giuspen.com/cherrytreemanual/#_exporting>
-- Choose "Export" -> "Export to CherryTreeDocument" -> "All the Tree" -> "XML, Not Protected (.cdt)"
+- [Website](https://www.giuspen.net/cherrytree/)
+- Typical extension: `.ctd`
 
-## Import to Joplin
+## Instructions
 
-Example: `jimmy-cli-linux cherry.ctd --format cherrytree`
+1. Export as described in <https://www.giuspen.com/cherrytreemanual/#_exporting>
+    1. Choose "Export" -> "Export to CherryTreeDocument" -> "All the Tree" -> "XML, Not Protected (.cdt)"
+2. [Install jimmy](../index.md#Installation)
+3. Import to Joplin. Example: `jimmy-cli-linux cherry.ctd --format cherrytree`
 
 ## Import Structure
 

diff --git a/docs/formats/clipto.md b/docs/formats/clipto.md
@@ -1,12 +1,14 @@
-- [Website](https://clipto.pro/)
-- Typical extension: `.json`
+This page describes how to import notes from Clipto to Joplin.
 
-## Export Instructions
+## General Information
 
-!!! note
+- [Website](https://github.com/clipto-pro/Desktop)
+- Typical extension: `.json`
 
-    Export works with the mobile app only. See <https://github.com/clipto-pro/Desktop/issues/21#issuecomment-537401330>.
+## Instructions
 
-## Import to Joplin
+1. Export your notes from the mobile app [^export]
+2. [Install jimmy](../index.md#Installation)
+3. Import to Joplin. Example: `jimmy-cli-linux clipto_backup_240401_105154.json --format clipto`
 
-Example: `jimmy-cli-linux clipto_backup_240401_105154.json --format clipto`
+[^export]: Export works with the mobile app only. See <https://github.com/clipto-pro/Desktop/issues/21#issuecomment-537401330>.
diff --git a/docs/formats/day_one.md b/docs/formats/day_one.md
@@ -1,14 +1,16 @@
-- [Website](https://dayoneapp.com/)
-- Typical extension: `.zip`
+This page describes how to import notes from Day One to Joplin.
 
-## Export Instructions
+## General Information
 
-- <https://dayoneapp.com/guides/tips-and-tutorials/exporting-entries/>
-- Choose "Day One JSON (.zip)"
+- [Website](https://dayoneapp.com/)
+- Typical extension: `.zip`
 
-## Import to Joplin
+## Instructions
 
-Example: `jimmy-cli-linux Export-Tagebuch.zip --format day_one`
+1. Export as described in <https://dayoneapp.com/guides/tips-and-tutorials/exporting-entries/>
+    1. Choose "Day One JSON (.zip)"
+2. [Install jimmy](../index.md#Installation)
+3. Import to Joplin. Example: `jimmy-cli-linux Export-Tagebuch.zip --format day_one`
 
 ## Import Structure
 

diff --git a/docs/formats/default.md b/docs/formats/default.md
@@ -1,6 +1,6 @@
-The default import can be used to import single files or folders recursively.
+This page describes how to import notes from single files or folders (recursively) to Joplin.
 
-## Export Instructions
+## Supported Formats
 
 The default import covers the following formats:
 
@@ -22,9 +22,10 @@ The default import covers the following formats:
 - Markdown ([Commonmark](https://commonmark.org/))
 - txt
 
-## Import to Joplin
+## Instructions
 
-Examples:
+1. [Install jimmy](../index.md#Installation)
+2. Import to Joplin. Examples:
 
 ```sh
 # import a single file supported by pandoc

diff --git a/docs/formats/dynalist.md b/docs/formats/dynalist.md
@@ -1,10 +1,12 @@
-- [Website](https://dynalist.io/)
-- Typical extension: `.zip`
+This page describes how to import notes from Dynalist to Joplin.
 
-## Export Instructions
+## General Information
 
-<https://help.dynalist.io/article/79-back-up-your-data>
+- [Website](https://dynalist.io/)
+- Typical extension: `.zip`
 
-## Import to Joplin
+## Instructions
 
-Example: `jimmy-cli-linux dynalist-backup-2024-04-12.zip --format dynalist`
+1. Export as described in <https://help.dynalist.io/article/79-back-up-your-data>
+2. [Install jimmy](../index.md#Installation)
+3. Import to Joplin. Example: `jimmy-cli-linux dynalist-backup-2024-04-12.zip --format dynalist`
diff --git a/docs/formats/fusebase.md b/docs/formats/fusebase.md
@@ -1,12 +1,12 @@
-Also known as Nimbus Note.
+This page describes how to import notes from FuseBase (formerly Nimbus Note) to Joplin.
+
+## General Information
 
 - [Website](https://nimbusweb.me/note/)
 - Typical extension: Folder with `.zip` files
 
-## Export Instructions
-
-<https://nimbusweb.me/guides/settings/how-to-export-notes-to-html-or-pdf/>
-
-## Import to Joplin
+## Instructions
 
-Example: `jimmy-cli-linux nimbus_note/Example/ --format nimbus_note`
+1. Export as described in <https://nimbusweb.me/guides/settings/how-to-export-notes-to-html-or-pdf/>
+2. [Install jimmy](../index.md#Installation)
+3. Import to Joplin. Example: `jimmy-cli-linux nimbus_note/Example/ --format nimbus_note`
diff --git a/docs/formats/google_keep.md b/docs/formats/google_keep.md
@@ -1,13 +1,14 @@
-- [Website](https://keep.google.com/)
-- Typical extensions: `.zip`, `.tgz`
-
-## Export Instructions
+This page describes how to import notes from Google Keep to Joplin.
 
-Export via Takeout: <https://www.howtogeek.com/694042/how-to-export-your-google-keep-notes-and-attachments/>
+## General Information
 
-## Import to Joplin
+- [Website](https://keep.google.com/)
+- Typical extensions: `.zip`, `.tgz`
 
-Examples:
+## Instructions
 
-- `jimmy-cli-linux takeout-20240401T160516Z-001.zip --format google_keep`
-- `jimmy-cli-linux takeout-20240401T160556Z-001.tgz --format google_keep`
+1. Export via Takeout as described in <https://www.howtogeek.com/694042/how-to-export-your-google-keep-notes-and-attachments/>
+2. [Install jimmy](../index.md#Installation)
+3. Import to Joplin. Examples:
+    1. `jimmy-cli-linux takeout-20240401T160516Z-001.zip --format google_keep`
+    2. `jimmy-cli-linux takeout-20240401T160556Z-001.tgz --format google_keep`
diff --git a/docs/formats/joplin.md b/docs/formats/joplin.md
@@ -1,10 +1,12 @@
-- [Website](https://joplinapp.org/)
-- Typical extension: `.jex`
+This page describes how to import notes in Joplin's JEX format to Joplin.
 
-## Export Instructions
+## General Information
 
-<https://joplinapp.org/help/apps/import_export/#exporting>
+- [Website](https://joplinapp.org/)
+- Typical extension: `.jex`
 
-## Import to Joplin
+## Instructions
 
-Example: `jimmy-cli-linux 29_04_2024.jex --format joplin`
+1. Export as described in <https://joplinapp.org/help/apps/import_export/#exporting>
+2. [Install jimmy](../index.md#Installation)
+3. Import to Joplin. Example: `jimmy-cli-linux 29_04_2024.jex --format joplin`
diff --git a/docs/formats/jrnl.md b/docs/formats/jrnl.md
@@ -1,15 +1,17 @@
-- [Website](https://jrnl.sh/)
-- Typical extension: `.json`
+This page describes how to import notes from jrnl to Joplin.
 
-## Export Instructions
+## General Information
 
-- <https://jrnl.sh/en/stable/formats/#exporting-with-file>
-- Export as json to preserve metadata.
-- Example: `jrnl --format json --file myjournal.json`
+- [Website](https://jrnl.sh/)
+- Typical extension: `.json`
 
-## Import to Joplin
+## Instructions
 
-Example: `jimmy-cli-linux myjournal.json --format jrnl`
+1. Export as described in <https://jrnl.sh/en/stable/formats/#exporting-with-file>
+    1. Export as json to preserve metadata.
+    2. Example: `jrnl --format json --file myjournal.json`
+2. [Install jimmy](../index.md#Installation)
+3. Import to Joplin. Example: `jimmy-cli-linux myjournal.json --format jrnl`
 
 ## Import Structure
 

diff --git a/docs/formats/notion.md b/docs/formats/notion.md
@@ -1,11 +1,13 @@
-- [Website](https://www.notion.so/)
-- Typical extension: `.zip`
+This page describes how to import notes from Notion to Joplin.
 
-## Export Instructions
+## General Information
 
-- <https://www.notion.so/de-de/help/export-your-content>
-- Choose "Markdown and CSV" and uncheck "Create folder for sub-pages" when exporting.
+- [Website](https://www.notion.so/)
+- Typical extension: `.zip`
 
-## Import to Joplin
+## Instructions
 
-Example: `jimmy-cli-linux 72a2f31c-3a46-4b44-826d-ae046e693551_Export-d609fb9f-43a4-475d-ba88-1db3e9e6bcd2.zip --format notion`
+1. Export as described in <https://www.notion.so/de-de/help/export-your-content>
+    1. Choose "Markdown and CSV" and uncheck "Create folder for sub-pages" when exporting.
+2. [Install jimmy](../index.md#Installation)
+3. Import to Joplin. Example: `jimmy-cli-linux 72a2f31c-3a46-4b44-826d-ae046e693551_Export-d609fb9f-43a4-475d-ba88-1db3e9e6bcd2.zip --format notion`
diff --git a/docs/formats/obsidian.md b/docs/formats/obsidian.md
@@ -1,6 +1,11 @@
+This page describes how to import notes from Obsidian to Joplin.
+
+## General Information
+
 - [Website](https://obsidian.md/)
 - Typical extension: Folder with `.md` files
 
-## Import to Joplin
+## Instructions
 
-Example: `jimmy-cli-linux obsidian_vault/ --format obsidian`
+1. [Install jimmy](../index.md#Installation)
+2. Import to Joplin. Example: `jimmy-cli-linux obsidian_vault/ --format obsidian`
diff --git a/docs/formats/simplenote.md b/docs/formats/simplenote.md
@@ -1,10 +1,12 @@
-- [Website](https://simplenote.com/)
-- Typical extension: `.zip`
+This page describes how to import notes from Simplenote to Joplin.
 
-## Export Instructions
+## General Information
 
-<https://simplenote.com/help/#export>
+- [Website](https://simplenote.com/)
+- Typical extension: `.zip`
 
-## Import to Joplin
+## Instructions
 
-Example: `jimmy-cli-linux notes.zip --format simplenote`
+1. Export as described in <https://simplenote.com/help/#export>
+2. [Install jimmy](../index.md#Installation)
+3. Import to Joplin. Example: `jimmy-cli-linux notes.zip --format simplenote`
diff --git a/docs/formats/standard_notes.md b/docs/formats/standard_notes.md
@@ -1,13 +1,15 @@
-- [Website](https://standardnotes.com/)
-- Typical extension: `.zip`
+This page describes how to import notes from Simplenote to Joplin.
 
-## Export Instructions
+## General Information
 
-<https://standardnotes.com/help/14/how-do-i-create-and-import-backups-of-my-standard-notes-data>
+- [Website](https://standardnotes.com/)
+- Typical extension: `.zip`
 
-## Import to Joplin
+## Instructions
 
-Example: `jimmy-cli-linux "Standard Notes Backup - Sun Apr 28 2024 12_56_55 GMT+0200.zip" --format standard_notes`
+1. Export as described in <https://standardnotes.com/help/14/how-do-i-create-and-import-backups-of-my-standard-notes-data>
+2. [Install jimmy](../index.md#Installation)
+3. Import to Joplin. Example: `jimmy-cli-linux "Standard Notes Backup - Sun Apr 28 2024 12_56_55 GMT+0200.zip" --format standard_notes`
 
 ## Known Limitations
 

diff --git a/docs/formats/synology_note_station.md b/docs/formats/synology_note_station.md
@@ -1,13 +1,15 @@
-- [Website](https://www.synology.com/en-global/dsm/feature/note_station)
-- Typical extension: `.nsx`
+This page describes how to import notes from Synology Note Station to Joplin.
 
-## Export Instructions
+## General Information
 
-<https://kb.synology.com/en-global/DSM/help/NoteStation/note_station_managing_notes?version=7#t7>
+- [Website](https://www.synology.com/en-global/dsm/feature/note_station)
+- Typical extension: `.nsx`
 
-## Import to Joplin
+## Instructions
 
-Example: `jimmy-cli-linux notestation-test-books.nsx --format synology_note_station`
+1. Export as described in <https://kb.synology.com/en-global/DSM/help/NoteStation/note_station_managing_notes?version=7#t7>
+2. [Install jimmy](../index.md#Installation)
+3. Import to Joplin. Example: `jimmy-cli-linux notestation-test-books.nsx --format synology_note_station`
 
 ## Known Limitations
 

diff --git a/docs/formats/textbundle.md b/docs/formats/textbundle.md
@@ -1,3 +1,7 @@
+This page describes how to import notes from Textbundle to Joplin.
+
+## General Information
+
 - [Website](http://textbundle.org/)
 - Typical extensions: `.textbundle`, `.textpack`
 
@@ -11,9 +15,10 @@ Selection from [the textbundle website](http://textbundle.org/#supporting-apps):
 - Wordpress
 - Zettlr
 
-## Import to Joplin
-
-Examples:
+## Instructions
 
-- `jimmy-cli-linux "Textbundle Example v1.textbundle/" --format textbundle`
-- `jimmy-cli-linux "example.textpack" --format textbundle`
+1. Export from any of the mentioned apps
+2. [Install jimmy](../index.md#Installation)
+3. Import to Joplin. Examples:
+    1. `jimmy-cli-linux "Textbundle Example v1.textbundle/" --format textbundle`
+    2. `jimmy-cli-linux "example.textpack" --format textbundle`
diff --git a/docs/formats/tiddlywiki.md b/docs/formats/tiddlywiki.md
@@ -1,14 +1,16 @@
-- [Website](https://tiddlywiki.com/)
-- Typical extension: `.json`
+This page describes how to import notes from TiddlyWiki to Joplin.
 
-## Export Instructions
+## General Information
 
-- <https://tiddlywiki.com/static/How%2520to%2520export%2520tiddlers.html>
-- Choose the json export.
+- [Website](https://tiddlywiki.com/)
+- Typical extension: `.json`
 
-## Import to Joplin
+## Instructions
 
-Example: `jimmy-cli-linux tiddlers.json --format tiddlywiki`
+1. Export as described in <https://tiddlywiki.com/static/How%2520to%2520export%2520tiddlers.html>
+    1. Choose json export
+2. [Install jimmy](../index.md#Installation)
+3. Import to Joplin. Example: `jimmy-cli-linux tiddlers.json --format tiddlywiki`
 
 ## Known Limitations