diff --git a/docs/help/contents/_include/colored-note-sidemenu.png b/docs/help/contents/_include/colored-note-sidemenu.png new file mode 100644 index 000000000..8c50f94f8 Binary files /dev/null and b/docs/help/contents/_include/colored-note-sidemenu.png differ diff --git a/docs/help/contents/_include/colored-note.png b/docs/help/contents/_include/colored-note.png new file mode 100644 index 000000000..a73079d97 Binary files /dev/null and b/docs/help/contents/_include/colored-note.png differ diff --git a/docs/help/contents/_include/editor-status-bar-desktop.png b/docs/help/contents/_include/editor-status-bar-desktop.png new file mode 100644 index 000000000..e24a45c1c Binary files /dev/null and b/docs/help/contents/_include/editor-status-bar-desktop.png differ diff --git a/docs/help/contents/_include/first-note-desktop.png b/docs/help/contents/_include/first-note-desktop.png new file mode 100644 index 000000000..7195b223b Binary files /dev/null and b/docs/help/contents/_include/first-note-desktop.png differ diff --git a/docs/help/contents/_include/first-note-mobile.png b/docs/help/contents/_include/first-note-mobile.png new file mode 100644 index 000000000..7d9885e39 Binary files /dev/null and b/docs/help/contents/_include/first-note-mobile.png differ diff --git a/docs/help/contents/_include/notebook-ref.png b/docs/help/contents/_include/notebook-ref.png new file mode 100644 index 000000000..4d2d2e46e Binary files /dev/null and b/docs/help/contents/_include/notebook-ref.png differ diff --git a/docs/help/contents/_include/plus-button-desktop.png b/docs/help/contents/_include/plus-button-desktop.png new file mode 100644 index 000000000..ef7a74d6b Binary files /dev/null and b/docs/help/contents/_include/plus-button-desktop.png differ diff --git a/docs/help/contents/_include/plus-button-mobile.png b/docs/help/contents/_include/plus-button-mobile.png new file mode 100644 index 000000000..83dddd75a Binary files /dev/null and b/docs/help/contents/_include/plus-button-mobile.png differ diff --git a/docs/help/contents/_include/plus-button.png b/docs/help/contents/_include/plus-button.png new file mode 100644 index 000000000..e6674718d Binary files /dev/null and b/docs/help/contents/_include/plus-button.png differ diff --git a/docs/help/contents/_include/sidemenu.png b/docs/help/contents/_include/sidemenu.png new file mode 100644 index 000000000..412f9ba46 Binary files /dev/null and b/docs/help/contents/_include/sidemenu.png differ diff --git a/docs/help/contents/_include/tagged-note-mobile.png b/docs/help/contents/_include/tagged-note-mobile.png new file mode 100644 index 000000000..210a89d99 Binary files /dev/null and b/docs/help/contents/_include/tagged-note-mobile.png differ diff --git a/docs/help/contents/_include/tagged-note.png b/docs/help/contents/_include/tagged-note.png new file mode 100644 index 000000000..bc55eb104 Binary files /dev/null and b/docs/help/contents/_include/tagged-note.png differ diff --git a/docs/help/contents/_include/tags-in-editor.png b/docs/help/contents/_include/tags-in-editor.png new file mode 100644 index 000000000..de0a2dbee Binary files /dev/null and b/docs/help/contents/_include/tags-in-editor.png differ diff --git a/docs/help/contents/_include/three-dot-button.png b/docs/help/contents/_include/three-dot-button.png new file mode 100644 index 000000000..ca7e5d3e4 Binary files /dev/null and b/docs/help/contents/_include/three-dot-button.png differ diff --git a/docs/help/contents/backup-and-restore-notes-in-notesnook.md b/docs/help/contents/backup-and-restore-notes-in-notesnook.md new file mode 100644 index 000000000..8b451b22f --- /dev/null +++ b/docs/help/contents/backup-and-restore-notes-in-notesnook.md @@ -0,0 +1,51 @@ +--- +title: Backup and restore +--- + +## How to Backup your notes + +It is always a good practice to take a backup of your data so in case you lose access to your account, you don't lose your notes. Backing up your data is very simple in notesnook. + +# [Desktop/Web](#/tab/web) + +1. Go to Settings from Sidebar +2. Scroll down to `Backup & Restore` section +3. Click on `Backup Data` to download `.nnbackup` file + +# [Mobile](#/tab/mobile) + +1. Go to Settings from Sidebar +2. Scroll down to `Backup & Restore` section +3. Press on `Backup Data` to save `.nnbackup` file to phone storage + +--- + +### Encrypted Backups + +You can also enable encrypted backups option in app settings. This will encrypt all your backup files with your account password. + +### Backup Reminders (Desktop) + +The desktop app allows you to enable Backup Reminders which remind you to backup your data daily/weekly or monthly. + +### Automatic Backups (Mobile) + +On mobile apps you can enable automatic daily, weekly or monthly backups. Your data will backup automatically and backup file will be stored in your phone storage. + +## How to restore your notes + +# [Desktop/Web](#/tab/web) + +1. Go to Settings from Sidebar +2. Scroll down to `Backup & Restore` section +3. Click on `Restore Data` +4. Select the `.nnbackup` backup file you want to restore. + +# [Mobile](#/tab/mobile) + +1. Go to Settings from Sidebar +2. Scroll down to `Backup & Restore` section +3. Press on `Restore Data` +4. From `Restore Data` sheet, select the backup you want to restore. If your backup file is located in some other location, click on `Open file manager` on top right corner to select the file. + +--- diff --git a/docs/help/contents/creating-note.md b/docs/help/contents/creating-note.md index 62dc36ddc..7e2bed508 100644 --- a/docs/help/contents/creating-note.md +++ b/docs/help/contents/creating-note.md @@ -12,13 +12,30 @@ You are in a notes app, the first thing you want to do is make a note. 2. Start typing in the editor and your note will be saved. 3. As you type, your note is saved automatically whenever you stop for a few seconds. +![First note web](/first-note-desktop.png) + +{% info %} + +The bottom right corner of the app will show the no. of words of current note & the last saved time. + +![Status bar desktop](/editor-status-bar-desktop.png) + +{% end %} + # [Mobile](#/tab/mobile) 1. On mobile, just like desktop, regardless of what screen you have opened, you can always swipe from right to left and open the editor. 2. You can also press the `+` button on bottom right corner to open the editor when you are in notes, a topic or tag. -3. Start writing in editor and your note will be created. 3. As you type, your note is saved automatically whenever you stop for a few seconds. +![First note mobile](/first-note-mobile.png) + +{% info %} + +Below the note title is the editor status bar. It shows you the no. of words in the note and last saved time. + +{% end %} + --- And that is how you create your first private note in Notesnook! diff --git a/docs/help/contents/export-notes-from-notesnook.md b/docs/help/contents/export-notes-from-notesnook.md new file mode 100644 index 000000000..909cde40f --- /dev/null +++ b/docs/help/contents/export-notes-from-notesnook.md @@ -0,0 +1,21 @@ +--- +title: Exporting notes +--- + +# How do I export notes from Notesnook? + +You can export your notes as PDF, HTML, Markdown and Plain text files on desktop and mobile apps. + +# [Desktop/Web](#/tab/web) +1. Right click on a note to open `Note properties` +2. Click on 'Export' +3. Select the desired format to export in +4. Wait a few moments while your note is exported +5. Save the note in desired location +# [Mobile](#/tab/mobile) +1. Press the `three-dot more` button on a note to open `Note properties` sheet +2. Press on 'Export' +3. Select the desired format to export in +4. Wait a few moments while your note is exported +5. Exported notes are stored in `Notesnook/exported` folder. +--- \ No newline at end of file diff --git a/docs/help/contents/lock-notes-with-private-vault.md b/docs/help/contents/lock-notes-with-private-vault.md new file mode 100644 index 000000000..ebcaaf2bb --- /dev/null +++ b/docs/help/contents/lock-notes-with-private-vault.md @@ -0,0 +1,90 @@ +--- +title: Locking notes +--- + +# How do I lock notes with private vault? + +Notesnook is a private notes app. All your notes are encrypted and secure by default. We can not read them even if we want to on our servers. However you can still add an extra layer of security and encrypt your most important and sensitive notes by adding them to a vault. + +Adding notes to private vault is useful when you do not want anyone to read your notes, even if they have access to your phone. + +## Creating a vault + +# [Desktop/Web](#/tab/web) + +1. Go to Settings from Sidebar. +2. Click on `Create a vault` in `Vault` section. +3. Enter the password for the vault in dialog. +4. Click on create to create the vault. +5. Now you will be able to lock your notes with the password for vault. + +# [Mobile](#/tab/mobile) + +1. Go to Settings from Sidebar +2. Scroll down to `Privacy and Security` section +3. Press on `Create vault` +4. Enter password for the vault and reenter to confirm. +5. Press on `Create` button to create the vault. +6. Now you will be able to lock your notes with the password for vault. + +--- + +## Locking a note + +# [Desktop/Web](#/tab/web) + +1. Right click on any note +2. Select `Lock` from the `Note properties` menu +3. Enter the password for the vault in dialog. +4. Click on Lock to lock the note. + +# [Mobile](#/tab/mobile) + +1. Press on the `three-dot menu` button +2. Press on `Add to vault` button in `Note properties` menu +3. Enter password for the vault +4. Press on `Lock` to add note to vault. + +--- + +## Open/Edit/Delete a locked note + +To open, edit or delete a locked note, you must provide the password for the vault to unlock it. + +## Unlocking note permanently + +# [Desktop/Web](#/tab/web) + +1. Right click on any note +2. Select `Unlock` from the `Note properties` menu +3. Enter the password for the vault in dialog. +4. Click on Unlock to remove note from vault + +# [Mobile](#/tab/mobile) + +1. Press on the `three-dot menu` button +2. Press on `Remove from vault` button in `Note properties` menu +3. Enter password for the vault +4. Press on `Unlock` to remove note from vault. + +--- + +## Changing vault password + +# [Desktop/Web](#/tab/web) + +1. Go to Settings from Sidebar. +2. Click on `Change vault password` in `Vault` section. +3. Enter the old and new password for the vault in dialog. +4. Click on Change to update password +5. All your locked notes will be encrypted with the new password. + +# [Mobile](#/tab/mobile) + +1. Go to Settings from Sidebar. +2. Scroll down to `Privacy and Security` section +3. Press on `Change vault password` +4. Click on Change to update password +5. All your locked notes will be encrypted with the new password. + +--- diff --git a/docs/help/contents/note-sharing-with-monographs.md b/docs/help/contents/note-sharing-with-monographs.md new file mode 100644 index 000000000..96e661290 --- /dev/null +++ b/docs/help/contents/note-sharing-with-monographs.md @@ -0,0 +1,53 @@ +--- +title: Monographs +--- + +# Monographs + +Sharing a note with someone can be such a tedious task. You have to copy/download/export it to a file and upload it to some cloud storage and then attach it in an email and send it to them. + +With Notesnook, you don't need to do that anymore. Monographs enable you to share your notes with anyone in just one click. Once a note is published as a monograph, you get a public url which you can send to the person who needs access to information in the note. + +You can share this url with anyone to view the contents of the note without downloading Notesnook. And the cool part is, you can encrypt(lock) monographs with a password. + +## How to publish a note? + +# [Desktop/Web](#/tab/web) + +1. Right click on a note +2. Click on `Publish` from Note properties to open publish note dialog. +3. Click on `Publish` button to publish note. +4. Copy the url and send it to respective person. + +# [Mobile](#/tab/mobile) + +5. Tap on `three-dot menu` button on a note. +6. Tap on `Publish` in Note properties sheet to open Publish note sheet +7. Tap on `Publish` button to publish note. +8. Copy the url and send it to respective person. + +--- + +## Password protection + +When you are sharing sensitive information with someone, you can encrypt the monograph with a password. Only someone who has the password can decrypt and read the contents of the note. While you are on the Publish note dialog, turn on password protection and enter a password for the monograph. Then click publish to publish the note. + +## Self destruct + +Self destruct means that the published note can be viewed only once. Once someone visits the public url to see the contents of the note, the monograph is deleted and it cannot be viewed again. + +## Unpublish a monograph + +# [Desktop/Web](#/tab/web) + +1. Right click on a note +2. Click on `Publish` from Note properties to open publish note dialog. +3. Click on `Unpublish` button to unpublish note. + +# [Mobile](#/tab/mobile) + +4. Tap on `three-dot menu` button on a note. +5. Tap on `Publish` in Note properties sheet to open Publish note sheet +6. Tap on `Unpublish` button to unpublish note. + +--- diff --git a/docs/help/contents/organization/how-do-i-add-tags-to-notes.md b/docs/help/contents/organization/how-do-i-add-tags-to-notes.md index 3a594d6a3..dba717c2f 100644 --- a/docs/help/contents/organization/how-do-i-add-tags-to-notes.md +++ b/docs/help/contents/organization/how-do-i-add-tags-to-notes.md @@ -2,21 +2,49 @@ title: Tags --- -# Add tags to notes +# Tags Tags are a quick and simple way to organize your notes. ## Tagging a note + # [Desktop/Web](#/tab/web) + 1. Click on the note you want to add tags to and open it in editor -2. Click on `Properties` on top right corner -3. Add the tags you want to the note. -4. You can click on an added tag to remove it from the note. +2. Under the note title, focus the `Add a tag` input. +3. Type the tag name & press enter to add it. The input supports auto complete for existing tags +4. Clicking on a tag will remove it from the note. + +{% info %} + +Added tags also appear at the bottom of each note item in the notes list. Tapping on the tag takes you to the respective tag. + +![Tagged note](/tagged-note.png) + +{% end %} + + # [Mobile](#/tab/mobile) -1. Press on the `three-dot more` button to open `Note properties` -2. Enter a tag name then hit `enter` or add a `space` to make a tag. -3. Press on an added tag to remove it from the note. + +1. Press on the ![Three dot button](/three-dot-button.png) button on a note. +2. Click on `Add tags` button under the title +3. Type the tag name then press enter to add it +4. Pressing on the tag will remove it. + +{% info %} + +When you open a note in editor, tags will appear on top of title on mobile. Tapping on a tag will remove if from the note. + +![Tags in editor mobile](/tags-in-editor.png) + +Added tags also appear at the bottom of each note item in the notes list. Tapping on the tag takes you to the respective tag. + +![Tagged note](/tagged-note-mobile.png) + +{% end %} + --- ## Accessing your tags -You can access all your tags by going to `Tags` from the side menu. Clicking on any tag will show you all the notes that are using that tag. \ No newline at end of file + +You can access all your tags by going to `Tags` from the side menu. Clicking on any tag will show you all the notes that are using that tag. diff --git a/docs/help/contents/organization/how-do-i-organize-notes-using-colors.md b/docs/help/contents/organization/how-do-i-organize-notes-using-colors.md index 02eea6434..5a51e515b 100644 --- a/docs/help/contents/organization/how-do-i-organize-notes-using-colors.md +++ b/docs/help/contents/organization/how-do-i-organize-notes-using-colors.md @@ -4,32 +4,52 @@ title: Colors # Organize notes with colors -Colors are a simple and fast way to organize your notes. +Colors are a simple and quick way to organize your notes. -## Assign color to note +## Assign color to a note # [Desktop/Web](#/tab/web) -1. Click on the `three dot more` button or right click on a note to open `Note properties` menu -2. Add note to the desired color +1. Right click on a note +2. Click on `Assign colors` +3. Assign a color to the note. +4. You can click on the color again to remove note from that color -![](/static/color_note_desktop.png) - -3. You can click on the color again to remove note from the color - # [Mobile](#/tab/mobile) -1. Press the `three-dot more` button on right side on note to open `Note properties` sheet - -Click on the more button on right side of note. - -2. Add note to the desired color - -Select the desired color from the Bottom Sheet Menu. +# [Mobile](#/tab/mobile) +1. Press the ![Three dot button](/three-dot-button.png) button +2. Assign a color to a note from the color strip. 3. You can press on the color again to remove note from the color - --- + +--- + +{% info %} + +After you assign a color to a note, the note will adapt to that color. + +![Colored note](/colored-note.png) + +{% end %} ## Color Shortcuts -A shortcut to notes of specific color appears on side menu by default. The shortcut will appear as long as there is at least one note in a color. +Once you add some notes to a color, it will appear on the Side Menu. -![](/static/color_pinned_side_desktop.png) +![Colored note](/colored-note-sidemenu.png) + +## Renaming a color + +Colors can be renamed to anything you want. + +# [Desktop/Web](#/tab/web) + +1. Right click on a color in side menu +2. Click on "Rename color" +3. Edit the color and click "Save" + +# [Mobile](#/tab/mobile) + +1. Long press on a color in Side menu +2. Edit the color name and click "Save" + +--- diff --git a/docs/help/contents/organization/notebooks.md b/docs/help/contents/organization/notebooks.md deleted file mode 100644 index 090235787..000000000 --- a/docs/help/contents/organization/notebooks.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -title: Notebooks ---- - -# Organizing notes with notebooks - -Even with thousands of notes, using notebooks will always help you keep your notes organized and tidy with easy access. Every notebook consists of different topics where you can add and create your notes. - -### Creating a notebook -# [Desktop/Web](#/tab/web) -1. Go to `Notebooks` from side menu. -2. Click on the `+` button on top right corner to open `Create notebook` dialog -3. Add title and description(Optional) to for your notebook. -4. Add topics to your notebook. -5. Click on `Add` button. -6. You have created your notebook! -# [Mobile](#/tab/mobile) -1. Go to `Notebooks` from side menu. -2. Press the `+` button on bottom right corner to open `Create notebook` dialog -3. Add title and description(Optional) to for your notebook. -4. Add topics to your notebook. -5. Press the `Add` button. -6. You have created your notebook! ---- - -### Editing an existing notebook -# [Desktop/Web](#/tab/web) -1. Go to `Notebooks` from side menu. -2. Right click on the Notebook or click on the `three-dot more` button to open `Notebook properties` -3. Select `Edit Notebook` -4. Edit the title or description -5. Add/Remove/Rename any topics -6. Click on `Edit notebook` button to save the changes -# [Mobile](#/tab/mobile) -1. Go to `Notebooks` from side menu -2. Press the `three-dot more` button on the notebook to open `Notebook properties` sheet -3. Press on `Edit Notebook` -4. Add title and description(Optional) to for your notebook -5. Add topics to your notebook. -6. Press `Save` button to save changes ---- - -### Adding a new topic -# [Desktop/Web](#/tab/web) -1. Go to `Notebooks` and open a notebook -2. Click on the `+` button on top right corner to open `Add topic` dialog -3. Enter title of the topic -4. Click on `Add` button to add topic. -5. You have added a new topic to notebook -# [Mobile](#/tab/mobile) -1. Go to `Notebooks` and open a notebook -2. Press the `+` button on bottom right corner to open `Add topic` dialog -3. Enter title of the topic -4. Press the `Add` button. -5. You have added a new topic to notebook ---- - -### Editing an existing topic -# [Desktop/Web](#/tab/web) -1. Go to `Notebooks` and open a notebook -2. Right click on a topic or click on `three-dot more` button to open `Edit topic` dialog -3. Enter the new title for the topic -4. Click on `Edit topic` button to save changes -# [Mobile](#/tab/mobile) -1. Go to `Notebooks` and open a notebook -2. Press the `three-dot more` button to open `Topic properties` -3. Press on `Edit topic` to open `Edit topic` dialog -4. Enter the new title for the topic -5. Press `Save` button to save changes ---- -### Creating a new note in topic -# [Desktop/Web](#/tab/web) -1. Go to `Notebooks` and open a notebook -2. Open the topic in which you want to add a note -3. Click on the `+` button on top right corner and start writing note in the editor -4. Note will be added to the topic -# [Mobile](#/tab/mobile) -1. Go to `Notebooks` and open a notebook -2. Open the topic in which you want to add a note. -3. Click on the `+` button on bottom right corner to open the editor or just **swipe from right to left** to open editor -4. Start writing in editor to create a note in the topic ---- -### Adding an existing note to a topic -# [Desktop/Web](#/tab/web) -1. Right click on a note or click on the `three-dot more` button to open `Note properties` sheet -2. Select `Add to Notebook(s)` -3. Click on a notebook to expand topics -4. Select the topic(s) in which you want to add your note. **A single note can exist in multiple topics and notebooks.** -5. You can also create new topics/notebooks from the dialog quickly -6. Click done to close the dialog. -# [Mobile](#/tab/mobile) -1. Press the `three-dot more` button to open `Note properties` sheet -2. Press on `Add to` -3. Press on a notebook to expand topics -4. Select the topic(s) where you want to add your note. **A single note can exist in multiple topics and notebooks.** -5. You can also create new topics/notebooks from the dialog quickly -6. Once done, swipe down to close `Add to notebook(s)` sheet. ---- - -### Adding multiple notes to a topic -# [Desktop/Web](#/tab/web) -1. Right click on a note or click on the `three-dot more` button to `Note properties` menu -2. Click on `Select` to enter multi-select mode -3. Click on the notes you want to select. -4. Click on the `notebook-plus` button to the header to open `Add to notebook(s)` dialog -3. Click on a notebook to expand topics -4. Select the topic(s) in which you want to add your notes. **Notes can exist in multiple topics and notebooks.** -5. You can also create new topics/notebooks from the dialog quickly -6. Click done to close `Add to notebook(s)` dialog. -# [Mobile](#/tab/mobile) -1. Long press on a note. -2. Click on `Select` from the `Action bar`. -3. Press on the notes you want to select -4. Press the `+` button in top header to open `Add to notebook` sheet -3. Click on a notebook to expand topics -4. Select the topic(s) where you want to add your note. **Notes can exist in multiple topics and notebooks.** -5. You can also create new topics/notebooks from the dialog quickly -5. Once done, swipe down to close the sheet. ---- - -### Remove note from a topic -# [Desktop/Web](#/tab/web) -1. Right click on a note or click on the `three-dot more` button to open `Note properties` menu -2. Select `Add to Notebook(s)` -3. The notebooks in which the note exists will appear green. Click on the notebook to expand topics -4. Click on the topics in notebook from which you want to remove th note. **A single note can exist in multiple topics and notebooks.** -5. Click done to close the dialog. -# [Mobile](#/tab/mobile) -1. Press the `three-dot more` button on the note to open `Note properties` sheet -2. Press on `Add to` -3. The notebook(s) in which the note exists will appear green. Press on a notebook to expand topics -3. Press on `remove note` button on a topic to remove the note. -5. Once done, swipe down to close `Add to notebook(s)` sheet. ---- - -### Delete a topic -# [Desktop/Web](#/tab/web) -1. Go to `Notebooks` and open the notebook from which you want to delete a topic. -2. Right click on the topic or click on the `three-dot more` button to open `Topic properties` menu -3. Click on `Delete` to delete the topic. -# [Mobile](#/tab/mobile) -1. Go to `Notebooks` from side menu and open the notebook from which you want to delete a topic. -2. Press the `three-dot more` button to open `Topic properties` sheet -3. Press `Delete` to delete the topic. ---- - -### Move a notebook to trash -# [Desktop/Web](#/tab/web) -1. Go to `Notebooks` -2. Right click on the topic or click on the `three-dot more` button to open `Notebook properties` menu -3. Click on `Move to trash`. -4. Notebook will be kept in trash for 7 days after which it will be permanently removed. -# [Mobile](#/tab/mobile) -1. Go to `Notebooks` -2. Press the `three-dot more` button to open `Notebook properties` sheet -3. Press `Move to trash` to delete the topic. -4. Notebook will be kept in trash for 7 days after which it will be permanently removed. ---- - diff --git a/docs/help/contents/organization/organizing-notes-with-notebooks.md b/docs/help/contents/organization/organizing-notes-with-notebooks.md new file mode 100644 index 000000000..44dc76b29 --- /dev/null +++ b/docs/help/contents/organization/organizing-notes-with-notebooks.md @@ -0,0 +1,233 @@ +--- +title: Notebooks +--- + +# Organizing notes with notebooks + +Notebooks consist of topics where you can add/create and edit your notes. + +### Creating a notebook + +# [Desktop/Web](#/tab/web) + +1. Go to `Notebooks` from side menu. +2. Click on the ![Three dot button](/plus-button-desktop.png) button on top right corner. +3. Add title for your notebook. + +{% info %} + +Adding a description & topics are optional. + +{% end %} + +4. Click on `Create` button. +5. You have created your first notebook in Notesnook. + +# [Mobile](#/tab/mobile) + +1. Go to `Notebooks` from side menu. +2. Press the ![Three dot button](/plus-button-desktop.png) button on bottom right corner +3. Add title for your notebook. + +{% info %} + +Adding a description & topics are optional. + +{% end %} + +4. Press the `Create notebook` button. +5. You have created your first notebook in Notesnook. + +--- + +### Editing a notebook + +# [Desktop/Web](#/tab/web) + +1. Go to `Notebooks` from side menu. +2. Right click on the Notebook you want to edit and select "Edit" from dropdown. +3. Edit your notebook. +4. Click on `Save` button to save the changes. + +# [Mobile](#/tab/mobile) + +1. Go to `Notebooks` from side menu +2. Press the ![Three dot button](/three-dot-button.png) button on the notebook +3. Press on `Edit Notebook` +4. Edit your notebook +5. Press `Save` button to save changes + +--- + +### Create a new topic + +# [Desktop/Web](#/tab/web) + +1. Go to `Notebooks` and open a notebook +2. Click on the ![Three dot button](/plus-button-desktop.png) button on top right corner. +3. Enter title of the topic +4. Click on `Create topic` +5. You have added a new topic to notebook + +# [Mobile](#/tab/mobile) + +1. Go to `Notebooks` and open a notebook +2. Press the ![Three dot button](/plus-button-desktop.png) button on bottom right corner. +3. Enter title of the topic +4. Press the `Create` button. +5. You have added a new topic to notebook + +--- + +### Editing an existing topic + +# [Desktop/Web](#/tab/web) + +1. Go to `Notebooks` and open a notebook +2. Right click on a topic and select "Edit". +3. Edit the topic title +4. Click "Save" to save changes. + +# [Mobile](#/tab/mobile) + +1. Go to `Notebooks` and open a notebook +2. Press the ![Three dot button](/three-dot-button.png) button +3. Press on `Edit topic` +4. Edit title of topic +5. Press `Save` to save changes + +--- + +### Creating a new note in a notebook + +# [Desktop/Web](#/tab/web) + +1. Go to `Notebooks` and open a notebook +2. Open the topic in which you want to add a note +3. Click on the ![Three dot button](/plus-button-desktop.png) button on top right corner +4. Start writing in editor to create a note in the topic + +# [Mobile](#/tab/mobile) + +1. Go to `Notebooks` and open a notebook +2. Open the topic in which you want to add a note +3. Click on the ![Three dot button](/plus-button-desktop.png) button on bottom right corner to open the editor or just **swipe from right to left** to open editor +4. Start writing in editor to create a note in the topic + +--- + +{% info %} + +Once a note is added to a notebook, it's refernence will show on top of the note in the list. Clicking on it will take you to the topic. + +![Notebook reference on a note](/notebook-ref.png) + +{% end %} + + +### Adding a note to a topic + +# [Desktop/Web](#/tab/web) + +1. Right click on a note +2. Select `Add to Notebook(s)` +3. Select the notebook and topic in which you want to add the note +4. Click "Finish" to add the notes to the topic. + +5. You should now see the notebook/topic below the note title. You can click on it to navigate to the topic directly. + +# [Mobile](#/tab/mobile) + +1. Press the ![Three dot button](/three-dot-button.png) button +2. Press on `Add to notebook` button. +3. Select the notebook and topic in which you want to add the note. +4. Once done, swipe down to close the sheet. + +5. You should now see the notebook/topic on the top left side of the note. You can click on it to navigate to the topic directly. + +--- + +{% info %} + +In Notesnook a single note can exist in multiple Notebooks and topics. However a note shows at most only one reference on top. + +{% end %} + +### Adding multiple notes to a topic + +# [Desktop/Web](#/tab/web) + +1. Hold `Ctrl` key and click on the notes you want to select +2. Right click on selected notes +3. Click on `Add to notebook(s)`. +4. Select the notebook and topic in which you want to add the notes +5. Click "Finish" to add the notes to the topic. +6. You should now see the notebook/topic below the note title. You can click on it to navigate to the topic directly. + +# [Mobile](#/tab/mobile) + +1. Long press on a note. +2. Click on `Select` from the `Action bar`. +3. Select notes & press the ![Three dot button](/plus-button-desktop.png) button in top header +4. Select the notebook and topic in which you want to add the notes +5. Once done, swipe down to close the sheet. + +--- + +### Remove note from a topic + +# [Desktop/Web](#/tab/web) + +1. Right click on a note +2. Select `Add to Notebook(s)` +3. The notebooks in which the note exists will appear green. Click on the notebook to expand topics +4. Click on the topics in notebook from which you want to remove th note +5. Click "Finish" to save changes + +# [Mobile](#/tab/mobile) + +1. Press the ![Three dot button](/three-dot-button.png) button +2. Press on `Add to notebooks` +3. The notebook(s) in which the note exists will appear green. Press on a notebook to expand topics +4. Tap on topics you want to remove the note from +5. Once done, swipe down to close `Add to notebook(s)` sheet + +--- + +### Delete a topic + +# [Desktop/Web](#/tab/web) + +1. Go to `Notebooks` and open the notebook from which you want to delete a topic. +2. Right click on the topic +3. Click on `Delete` to delete the topic. +4. Select whether you also want to delete the notes inside this topic. + +# [Mobile](#/tab/mobile) + +1. Go to `Notebooks` from side menu and open the notebook from which you want to delete a topic. +2. Press the ![Three dot button](/three-dot-button.png) button to open `Topic properties` sheet +3. Press `Delete topic` +4. Select whether you also want to delete the notes inside this topic. + +--- + +### Move a notebook to trash + +# [Desktop/Web](#/tab/web) + +1. Go to `Notebooks` +2. Right click on the notebook +3. Click on `Move to trash`. +4. Select whether you also want to delete the notes inside this notebook. +5. Notebook will be kept in trash for 7 days after which it will be permanently removed. + +# [Mobile](#/tab/mobile) + +1. Go to `Notebooks` +2. Press the ![Three dot button](/three-dot-button.png) button. +3. Press `Move to trash` to delete the topic. +4. Select whether you also want to delete the notes inside this notebook. +5. Notebook will be kept in trash for 7 days after which it will be permanently removed. + +--- diff --git a/docs/help/contents/versionhistory.md b/docs/help/contents/versionhistory.md new file mode 100644 index 000000000..6499f2da3 --- /dev/null +++ b/docs/help/contents/versionhistory.md @@ -0,0 +1,13 @@ +--- +title: Version History +--- + +To improve the overall reliability of Notesnook we have introduced version history of notes in v1.7.0 of desktop and mobile apps. Version history is enabled by default for all your notes including notes in vault. + +## How it works + +When you create a new note or open an existing note in the editor, a session is generated from the note opened in editor. All the changes made to the note are stored in that session. So if you open a note and edit it at 10 different times during the day, 10 versions of note history are generated and stored. + +## Is Note history synced to all my devices? + +No, at the moment we have decided to keep note version history local only and it is not synced. Hence if you logout from your account, note version history will be deleted. diff --git a/docs/help/docgen.yaml b/docs/help/docgen.yaml index 1172c4df2..717e9d9a7 100644 --- a/docs/help/docgen.yaml +++ b/docs/help/docgen.yaml @@ -6,15 +6,20 @@ colors: main: "#008837" navigation: - path: contents/download-install.md - - path: contents/creating-note.md + - path: contents/creating-note.md - path: contents/encryption.md - path: contents/organization children: - - path: contents/organization/notebooks.md + - path: contents/organization/organizing-notes-with-notebooks.md - path: contents/organization/how-do-i-add-tags-to-notes.md - path: contents/organization/how-do-i-organize-notes-using-colors.md - path: contents/organization/how-do-i-organize-notes-using-favorites.md - path: contents/organization/how-do-i-pin-notes-and-notebooks.md - path: contents/organization/how-do-i-add-shortcuts-to-side-menu.md - path: contents/importing-notes - children: "*" \ No newline at end of file + children: "*" + - path: contents/backup-and-restore-notes-in-notesnook.md + - path: contents/export-notes-from-notesnook.md + - path: contents/lock-notes-with-private-vault.md + - path: contents/note-sharing-with-monographs.md + - path: contents/versionhistory.md