docs: improve importing documentation

JAsaxon · Jul 21, 2023 · c14b09e · c14b09e
1 parent 52fecc2
commit c14b09e
Show file tree

Hide file tree

Showing 22 changed files with 223 additions and 160 deletions.
diff --git a/apps/web/package-lock.json b/apps/web/package-lock.json
diff --git a/docs/help/contents/_include/static/html/1.png b/docs/help/contents/_include/static/html/1.png
diff --git a/.../help/contents/_include/static/html/3.png → ...contents/_include/static/import-ready.png b/.../help/contents/_include/static/html/3.png → ...contents/_include/static/import-ready.png
diff --git a/docs/help/contents/_include/static/import-zip-app.png b/docs/help/contents/_include/static/import-zip-app.png
diff --git a/docs/help/contents/_include/static/markdown-importer/1.png b/docs/help/contents/_include/static/markdown-importer/1.png
diff --git a/docs/help/contents/_include/static/markdown-importer/2.png b/docs/help/contents/_include/static/markdown-importer/2.png
diff --git a/docs/help/contents/_include/static/markdown-importer/3.png b/docs/help/contents/_include/static/markdown-importer/3.png
diff --git a/docs/help/contents/_include/static/plaintext-importer/1.png b/docs/help/contents/_include/static/plaintext-importer/1.png
diff --git a/docs/help/contents/_include/static/plaintext-importer/2.png b/docs/help/contents/_include/static/plaintext-importer/2.png
diff --git a/docs/help/contents/importing-notes/import-notes-from-evernote.md b/docs/help/contents/importing-notes/import-notes-from-evernote.md
@@ -4,28 +4,46 @@ title: Evernote
 
 # How do I import notes from Evernote?
 
-The following steps will help you import your notes from EverNote easily.
+The following steps will help you quickly import your notes from Evernote into Notesnook.
 
-1. Open Evernote app on Desktop and Go to `Notebooks` from the side menu
-   <img style="margin-bottom:15px;" src="/static/evernote-importer/1.png" alt="Go to `Notebooks` from the side menu"/>
+## Exporting your Evernote notebooks
 
-2. Click on the `three-dot` button on each notebook and click on `Export Notebook`
-   <img style="margin-bottom:15px;" src="/static/evernote-importer/2.png" alt="Click on the `three-dot` button on each notebook and click on `Export Notebook`"/>
-
-3. Choose `.enex` format and click on `Export` and save it to desired location. Repeat this for all Notebooks you want to import.
-   <img style="margin-bottom:15px;" src="/static/evernote-importer/3.png" alt="Choose `.enex` format and click on `Export`"/>
-
-4. Go to [Notesnook importer](https://importer.notesnook.com) and select Evernote from the list of apps.
-   <img style="margin-bottom:15px;" src="/static/evernote-importer/4.png" alt="Select Evernote importer"/>
-
-5. Drop the `.enex` backup files you exported earlier from EverNote in the box and click start processing.
+> info
+>
+> If you are tech savvy and know your way around a computer, you can use a tool like [evernote-backup](https://github.com/vzhd1701/evernote-backup) to quickly export all your Evernote notes as .ENEX files.
 
-   <img style="margin-bottom:15px;" src="/static/evernote-importer/5.png" alt="Processing Evernote files"/>
-
-6. Once importer completes processing, download the .zip file.
-   <img style="margin-bottom:15px;" src="/static/evernote-importer/6.png" alt="Download importer .zip file"/>
-
-7. After you have downloaded the `.zip` file, go to Notesnook app > Settings > Notesnook Importer and click on "Import from ZIP file" & select the .zip you downloaded earlier.
-   <img style="margin-bottom:15px;" src="/static/import-zip-app.png" alt="Import .zip in Notesnook app"/>
-
-8. Once importing completes you should see all your notes in Notesnook. If you face any issues during importing, [report it on github](https://github.com/streetwriters/notesnook).
+1. Open the Evernote Desktop app (its not possible to export notes from the Evernote web app), and go to `Notebooks` from the side menu:
+   ![](/static/evernote-importer/1.png)
+2. Click on the `three-dot` button on each notebook and click on `Export Notebook`
+   ![](/static/evernote-importer/2.png)
+3. Choose `ENEX format` then click on `Export`, and save it to your desired location. Repeat this for all the Notebooks you want to import into Notesnook.
+   ![](/static/evernote-importer/3.png)
+
+## Importing .ENEX files into Notesnook
+
+Once you have all the .ENEX files containing your Evernote notes, its time to import them into Notesnook.
+
+1. Go to [Notesnook importer](https://importer.notesnook.com) and select Evernote from the list of apps.
+   ![](/static/evernote-importer/4.png)
+2. Drop (or select) the `.enex` files you exported earlier from Evernote, and click the "Start processing" button.
+   ![](/static/evernote-importer/5.png)
+3. Once the Importer finishes processing your files, download the .zip file.
+   ![](/static/import-ready.png)
+4. After you have downloaded the `.zip` file, [go to the Notesnook Web App](https://app.notesnook.com/) > Settings > Notesnook Importer. Select the .zip you downloaded earlier and click "Start import" button.
+   ![](/static/import-zip-app.png)
+5. Once importing completes you should see all your notes in Notesnook. If you face any issues during importing, feel free to [report them on GitHub](https://github.com/streetwriters/notesnook-importer).
+
+## Supported formats
+
+Notesnook Importer is one of the most robust Evernote importers around supporting almost 100% of Evernote formats. Here's a list of everything that can (or can't be) imported into Notesnook:
+
+- [x] Attachments
+- [x] Web clips (full page, screenshot, bookmark, article, & simplified article are all supported)
+- [x] Tasks (currently only the task items get imported without any metadata)
+- [x] Links
+- [x] Images
+- [x] Rich text (bold, italic, lists etc.)
+- [ ] Reminders
+- [ ] Internal note links
+- [x] Notebooks
+- [x] Tags
diff --git a/docs/help/contents/importing-notes/import-notes-from-googlekeep.md b/docs/help/contents/importing-notes/import-notes-from-googlekeep.md
@@ -4,29 +4,40 @@ title: Google Keep
 
 # How do I import notes from Google Keep?
 
-The following steps will help you import your notes from Google Keep easily.
-
-1. Go to [Google Takeout](https://takeout.google.com/settings/takeout) and Login to your account.
-
-2. On Google Takeout Page, first click on `Deselect all` then scroll down and select `Keep` and click `Next Step`.
-   <img style="margin-bottom:15px;" src="/static/google-keep-importer/1.png" alt="On Google Takeout Page, first click on `Deselect all` then scroll down and select `Keep` and click `Next Step`."/>
-
-3. Click on create export
-   <img style="margin-bottom:15px;" src="/static/google-keep-importer/2.png" alt="Click on create export"/>
-
-4. Download your exported file.
-   <img style="margin-bottom:15px;" src="/static/google-keep-importer/3.png" alt="Download your exported file."/>
-
-5. Go to [Notesnook Importer](https://importer.notesnook.com) and select `Google Keep` from list of apps.
-   <img style="margin-bottom:15px;" src="/static/google-keep-importer/4.png" alt="Go to [Notesnook Importer](https://importer.notesnook.com) and select `Google Keep` from list of apps."/>
-
-6. Drop the .zip backup file(s) you exported earlier from Google Takeout in the box or click anywhere to open system file picker to select the backup.
-   <img style="margin-bottom:15px;" src="/static/google-keep-importer/5.png" alt="Drop the .zip backup file(s) you exported earlier from Google Takeout in the box or click anywhere to open system file picker to select the backup."/>
-
-7. Once processing completes, click on "Download ZIP file" to download the exported notes.
-   <img style="margin-bottom:15px;" src="/static/google-keep-importer/6.png" alt="Click on `Download .nnbackup` to download the file."/>
-
-8. After you have downloaded the `.zip` file, go to Notesnook app > Settings > Notesnook Importer and click on "Import from ZIP file" & select the .zip you downloaded earlier.
-   <img style="margin-bottom:15px;" src="/static/import-zip-app.png" alt="Import .zip in Notesnook app"/>
-
-9. Once importing completes you should see all your notes in Notesnook. If you face any issues during importing, [report it on github](https://github.com/streetwriters/notesnook).
+The following steps will help you quickly import your notes from Google Keep into Notesnook.
+
+## Exporting your Google Keep notes
+
+1. Go to [Google Takeout](https://takeout.google.com/settings/takeout) and log into your Google account.
+2. On the Google Takeout page, first deselect all the items by clicking on `Deselect all`, and then scroll down and select only `Keep` from the list. Once selected, click on `Next Step` by scrolling to the very bottom of the page.
+   ![](/static/google-keep-importer/1.png)
+3. On the next section, leave everything as is and just click on the "Create export" button:
+   ![](/static/google-keep-importer/2.png)
+4. Download the exported .zip file once it becomes available:
+   ![](/static/google-keep-importer/3.png)
+
+## Importing Google Takeout into Notesnook
+
+Once you have the Google Takeout containing your Google Keep notes, its time to import them into Notesnook.
+
+1. Go to [Notesnook Importer](https://importer.notesnook.com) and select `Google Keep` from list of apps.
+   ![](/static/google-keep-importer/4.png)
+2. Drop the .zip backup file(s) you exported earlier from Google Takeout in the box or click anywhere to open system file picker to select the backup.
+   ![](/static/google-keep-importer/5.png)
+3. Once the Importer finishes processing your files, download the .zip file.
+   ![](/static/import-ready.png)
+4. After you have downloaded the `.zip` file, [go to the Notesnook Web App](https://app.notesnook.com/) > Settings > Notesnook Importer. Select the .zip you downloaded earlier and click "Start import" button.
+   ![](/static/import-zip-app.png)
+5. Once importing completes you should see all your notes in Notesnook. If you face any issues during importing, feel free to [report them on GitHub](https://github.com/streetwriters/notesnook-importer).
+
+## Supported formats
+
+Notesnook Importer is one of the most robust Google Keep importers around supporting almost 100% of Google Keep formats. Here's a list of everything that can (or can't be) imported into Notesnook:
+
+- [x] Attachments
+- [x] Images
+- [x] Checklists & other lists
+- [x] Links
+- [x] Tags/Labels
+- [x] Pinned status
+- [x] Colors
diff --git a/docs/help/contents/importing-notes/import-notes-from-html-files.md b/docs/help/contents/importing-notes/import-notes-from-html-files.md
@@ -4,18 +4,14 @@ title: HTML files
 
 # How do I import notes from HTML files?
 
-To import html files to notesnook go to Notesnook Importer on your PC/Laptop.
+To import HTML files to Notesnook, [go to Notesnook Importer](https://importer.notesnook.com/) on your PC/Laptop.
 
-1. From the list of formats to import, select "Plain Text".
-   <img style="margin-bottom:15px;" src="/static/html/1.png" alt="From the list of formats to import, select Plain Text."/>
-
-2. Drop your html files or click anywhere inside the box to browse and select your html files. Once selected, click on "Start processing".
-   <img style="margin-bottom:15px;" src="/static/html/2.png" alt="From the list of formats to import, select Plain Text."/>
-
-3. Once importer completes processing, download the .zip file.
-   <img style="margin-bottom:15px;" src="/static/html/3.png" alt="Download importer .zip file"/>
-
-4. After you have downloaded the `.zip` file, go to Notesnook app > Settings > Notesnook Importer and click on "Import from ZIP file" & select the .zip you downloaded earlier.
-   <img style="margin-bottom:15px;" src="/static/import-zip-app.png" alt="Import .zip in Notesnook app"/>
-
-5. Once importing completes you should see all your notes in Notesnook. If you face any issues during importing, [report it on github](https://github.com/streetwriters/notesnook).
+1. From the list of note apps to import from, select "Text".
+   ![](/static/html/1.png)
+2. Drop your .html files, or click anywhere inside the box to browse and select your .html files. You can also provide a .zip file containing all your .html files. Then click "Start processing".
+   ![](/static/html/2.png)
+3. Once the Importer finishes processing your files, download the .zip file.
+   ![](/static/import-ready.png)
+4. After you have downloaded the `.zip` file, [go to the Notesnook Web App](https://app.notesnook.com/) > Settings > Notesnook Importer. Select the .zip you downloaded earlier and click "Start import" button.
+   ![](/static/import-zip-app.png)
+5. Once importing completes you should see all your notes in Notesnook. If you face any issues during importing, feel free to [report them on GitHub](https://github.com/streetwriters/notesnook-importer).
diff --git a/docs/help/contents/importing-notes/import-notes-from-joplin.md b/docs/help/contents/importing-notes/import-notes-from-joplin.md
@@ -6,19 +6,23 @@ title: Joplin
 
 The following steps will help you import your notes from Joplin easily.
 
-1. Open Joplin app on Desktop and click on `File` and select `Export All -> JEX - Joplin Export File` and save it in desired location.
-   <img style="margin-bottom:15px;" src="/static/joplin-importer/1.png" alt="Click on `File` and select `Export All -> JEX - Joplin Export File`"/>
-
+1. Open the Joplin Desktop app.
+2. Click on `File > Export All -> JEX - Joplin Export File` and save the .JEX file at your desired location.
+   ![](/static/joplin-importer/1.png)
 2. Go to [Notesnook Importer](https://importer.notesnook.com) and select `Joplin` from list of apps.
-   <img style="margin-bottom:15px;" src="/static/joplin-importer/2.png" alt=" Go to Notesnook Importer https://importer.notesnook.com and select `Joplin` from list of apps."/>
-
-3. Drop the .jex backup file you exported earlier from Joplin in the box or click anywhere to open system file picker to select the backup.
-   <img style="margin-bottom:15px;" src="/static/joplin-importer/3.png" alt="Drop the .zip backup file you exported earlier from Standard Notes in the box or click anywhere to open system file picker to select the backup."/>
-
-4. Once importer completes processing, download the .zip file.
-   <img style="margin-bottom:15px;" src="/static/joplin-importer/4.png" alt="Download importer .zip file"/>
-
-5. After you have downloaded the `.zip` file, go to Notesnook app > Settings > Notesnook Importer and click on "Import from ZIP file" & select the .zip you downloaded earlier.
-   <img style="margin-bottom:15px;" src="/static/import-zip-app.png" alt="Import .zip in Notesnook app"/>
-
-6. Once importing completes you should see all your notes in Notesnook. If you face any issues during importing, [report it on github](https://github.com/streetwriters/notesnook).
+   ![](/static/joplin-importer/2.png)
+3. Drop (or select) the .jex backup file you exported earlier from Joplin:
+   ![](/static/joplin-importer/3.png)
+4. Once the Importer finishes processing your files, download the .zip file.
+   ![](/static/import-ready.png)
+5. After you have downloaded the `.zip` file, [go to the Notesnook Web App](https://app.notesnook.com/) > Settings > Notesnook Importer. Select the .zip you downloaded earlier and click "Start import" button.
+   ![](/static/import-zip-app.png)
+6. Once importing completes you should see all your notes in Notesnook. If you face any issues during importing, feel free to [report them on GitHub](https://github.com/streetwriters/notesnook-importer).
+
+## Supported formats
+
+- [x] Rich text (lists, links, bold, italic etc.)
+- [x] Images & attachments
+- [x] Tags
+- [x] Folders (currently only 2 levels of nesting is supported)
+- [ ] Internal links to other notes
diff --git a/docs/help/contents/importing-notes/import-notes-from-mardown-files.md b/docs/help/contents/importing-notes/import-notes-from-mardown-files.md
diff --git a/docs/help/contents/importing-notes/import-notes-from-markdown-files.md b/docs/help/contents/importing-notes/import-notes-from-markdown-files.md
@@ -0,0 +1,28 @@
+---
+title: Markdown files
+---
+
+# How do I import notes from Markdown files?
+
+To import Markdown files to Notesnook, [go to Notesnook Importer](https://importer.notesnook.com/) on your PC/Laptop.
+
+1. From the list of note apps to import from, select "Markdown".
+   ![](/static/markdown-importer/1.png)
+2. Drop your .md files, or click anywhere inside the box to browse and select your .md files. You can also provide a .zip file containing all your .md files. Then click "Start processing".
+   ![](/static/markdown-importer/2.png)
+3. Once the Importer finishes processing your files, download the .zip file.
+   ![](/static/import-ready.png)
+4. After you have downloaded the `.zip` file, [go to the Notesnook Web App](https://app.notesnook.com/) > Settings > Notesnook Importer. Select the .zip you downloaded earlier and click "Start import" button.
+   ![](/static/import-zip-app.png)
+5. Once importing completes you should see all your notes in Notesnook. If you face any issues during importing, feel free to [report them on GitHub](https://github.com/streetwriters/notesnook-importer).
+
+## Supported formats
+
+- [x] 100% support for CommonMark syntax
+- [x] GitHub flavored markdown (task lists, tables etc.)
+- [x] Obsidian flavored markdown (embedded files, comments etc.)
+- [x] Subscript and superscript (`H~2~O` and `19^th^`)
+- [x] Highlights (`==highlighted==`)
+- [x] Images and links (links that point to files get added as attachments)
+
+> Note: For best results, it is recommended to ZIP all your .md files and their attachments so they can be found by the importer.
diff --git a/docs/help/contents/importing-notes/import-notes-from-obsidian.md b/docs/help/contents/importing-notes/import-notes-from-obsidian.md
@@ -0,0 +1,26 @@
+---
+title: Obsidian
+---
+
+# How do I import notes from Obsidian?
+
+To import Obsidian notes into Notesnook, [go to Notesnook Importer](https://importer.notesnook.com/) on your PC/Laptop.
+
+1. From the list of note apps to import from, select "Obsidian".
+   ![](/static/markdown-importer/1.png)
+2. Drop your .md files from your Obsidian Vault, or click anywhere inside the box to browse and select your .md files. You can also provide a .zip file containing all your Obsidian .md files. Then click "Start processing".
+   ![](/static/markdown-importer/2.png)
+3. Once the Importer finishes processing your files, download the .zip file.
+   <img src="/static/import-ready.png" alt="Download importer .zip file"/>
+4. After you have downloaded the `.zip` file, [go to the Notesnook Web App](https://app.notesnook.com/) > Settings > Notesnook Importer. Select the .zip you downloaded earlier and click "Start import" button.
+   <img src="/static/import-zip-app.png" alt="Import .zip in Notesnook app"/>
+5. Once importing completes you should see all your notes in Notesnook. If you face any issues during importing, feel free to [report them on GitHub](https://github.com/streetwriters/notesnook-importer).
+
+## Supported formats
+
+- [ ] Internal links
+- [x] Embedded files (supporting both `![[path-to-file]]` and `![](path/to/image.png)`)
+- [x] Full CommonMark Markdown syntax
+- [ ] Callouts
+- [x] Metadata (tags etc.)
+- [x] Comments (block & inline both get removed)