Skip to content

Commit

Permalink
docs: update outdated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
thecodrr committed Oct 3, 2023
1 parent 3895569 commit 848fdda
Show file tree
Hide file tree
Showing 17 changed files with 149 additions and 243 deletions.
2 changes: 1 addition & 1 deletion docs/help/contents/404.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ Unfortunately, we cannot find what you are looking for.

Here are some other pages you might be interested in:

1. [Installing Notesnook](installation)
1. [Installing Notesnook](organizing-notes/organize-notes-using-notebooks)
2. [Creating your first note](create-a-note-in-notesnook)
3. [How is my data encrypted?](how-is-my-data-encrypted)
4 changes: 3 additions & 1 deletion docs/help/contents/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,6 @@ Notesnook is our **proof** that privacy does _not_ (always) have to come at the

And with that convenience in mind, we believe that it is equally important to put together a simple & useful help website about everything Notesnook. Our help is a complete walkthrough of the Notesnook app and it's features.

So let's get started with [installing Notesnook](/installation) on all your devices.
Before we get started, let's [download & install Notesnook](https://notesnook.com/downloads) on all your devices.

Once that's done, let's learn how to [create your first note](/create-a-note-in-notesnook) in Notesnook.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/help/contents/_include/auto-backups-web.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/help/contents/_include/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,10 @@ nav li {
line-height: 24px;
}

li.nested {
min-height: 38px !important;
}

nav li li:not(li.nested):hover {
background-color: var(--hover-bg);
}
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
76 changes: 48 additions & 28 deletions docs/help/contents/backup-and-restore-notes-in-notesnook.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,41 +5,58 @@ description: Notesnook allows you to backup all your notes data to a single back

# 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. Currently backups are local only.
It is always a good practice to take regular backups of your data so you can easily recover your data in case of data corruption or losing access to your account. All backups are stored locally encrypted (unless you turn off backup encryption) on your device.

> warning
> error Store your password & recovery key safely
>
> Since all your data is end-to-end encrypted, we do not have the access to restore your account if you forgot your account password and recovery key. Therefore we recommend that you store your password safely and make sure that you have saved your account recovery.
> Since all your data is end-to-end encrypted, we have no way to restore your account data if you forget your account password and lose your account recovery key. That's why we recommend that you store your password & recovery key in a password manager or some other safe place.
# [Desktop/Web](#/tab/web)

1. Go to Settings from Sidebar
2. Scroll down to `Backup & Restore` section
3. Click on `Backup Data` to download the `.nnbackup` file
1. Go to Settings
2. Scroll down in the Settings navigation menu and click on `Backup & export` section
3. Click on `Create backup` under `Backup now` heading to create a new `.nnbackupz` file

![](/create-backup-web.png)

# [Mobile](#/tab/mobile)

1. Go to Settings from Sidebar
2. Scroll down to `Backup and Restore`
3. Go to `Backups`
4. Press on `Backup now` to save `.nnbackup` file
3. Tap on `Backups`
4. Press on `Backup now` to create a new `.nnbackupz` file

> info
>
> On **Android** when you take a backup first time, you will be asked to select a folder on your phone where you would like to store backup files. You can always change your backup files location from `Backups > Change backup location`.
> On **Android** when you take a backup for the first time, you will be asked to select a folder where you want to store all your backup files. You can always change your backup files location from `Backups > Select backup directory`.
>
> Regardless of the folder you select, Notesnook will create a folder "Notesnook/backups" inside it and store backup files there.
> Regardless of the folder you select, Notesnook will create a folder "Notesnook/backups" inside it and store all backup files there.
---

## Automatic Backups

On mobile and desktop apps you can enable automatic daily, weekly or monthly backups of your notes. Your data will backup automatically and backup file will be stored locally.
For maximum safety against potential data loss, you can enable daily, weekly or monthly backups of your notes. Enabling automatic backups will ensure that all your data is safely backed up locally after a regular interval.

# [Desktop/Web](#/tab/web)
# [Desktop](#/tab/desktop)

1. Go to Settings > Backup & Restore
2. Select automatic backup frequency to enable automatic backups
1. Go to Settings
2. Scroll down in the Settings navigation menu and click on `Backup & export` section
3. Select the Automatic backups interval from the dropdown

![](/auto-backups-desktop.png)

# [Web](#/tab/web)

> info
>
> On the **web** app there is no way to automatically save backups to a folder, that is why Notesnook only reminds the users when it's time to create a new backup.
1. Go to Settings
2. Scroll down in the Settings navigation menu and click on `Backup & export` section
3. Select the Backup reminders interval from the dropdown

![](/auto-backups-web.png)

# [Mobile](#/tab/mobile)

Expand All @@ -51,41 +68,44 @@ On mobile and desktop apps you can enable automatic daily, weekly or monthly bac

## Encrypted Backups (Recommended)

To keep your backups secure & private, it is recommended that you enable encryption on your backup files instead of storing them as plain json data.
To keep your backups secure & private, it is recommended that you enable encryption on your backup files instead of storing them as plaintext data. **Starting from v2.6.0, encrypted backups are enabled by default for all users, free or Pro.**

# [Desktop/Web](#/tab/web)

1. Go to Settings > Backup & Restore
2. Enable encrypted backups option
1. Go to Settings
2. Scroll down in the Settings navigation menu and click on `Backup & export` section
3. Click on the toggle next to `Backup encryption` to enable/disable encrypted backups

# [Mobile](#/tab/mobile)

1. Go to Settings > Backup & Restore
2. Press Backups
3. Enable encrypted backups option
1. Go to `Settings` > `Backup & Restore`
2. Tap on `Backups`
3. Tap on the toggle next to `Backup encryption` to enable/disable encrypted backups

---

> info
>
> Backups are encrypted with your account password.
> Backups are always encrypted with your account password.
# Restore a backup

To restore a backup, you must be logged in to your Notesnook account.
At any point in time, you can restore a backup to recover lost data. However, **to restore a backup, you must be logged in to your Notesnook account.** Backups created on one account can be restored on another Notesnook account.

# [Desktop/Web](#/tab/web)

1. Go to Settings from Sidebar
2. Scroll down to `Backup & Restore` section
3. Click on `Restore backup`
4. Select the `.nnbackup` file from your PC that you want to restore.
1. Go to Settings
2. Scroll down in the Settings navigation menu and click on `Backup & export` section
3. Click on `Restore` button next to `Restore backup` heading
4. Select the `.nnbackupz` or `.nnbackup` file from your PC that you want to restore.

# [Mobile](#/tab/mobile)

1. Go to Settings from Sidebar
2. Scroll down to `Backup & Restore` section
3. Press on `Restore backup`
4. From `Restore backup` 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 of the sheet then select the backup file.
3. Tap on `Restore backup`
4. From `Restore backup` sheet, select the backup you want to restore. If your backup file is located in some other location, click on `Restore from files` on top right corner of the sheet then select the backup file.

<img src="/restore-backup-mobile.png" height="700px">

---
15 changes: 8 additions & 7 deletions docs/help/contents/create-a-note-in-notesnook.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,34 @@ description: Notesnook let's you create unlimited notes for free. Learn how you

# Creating your first note

You are in a notes app, the first thing you want to do is make a note.
You are in a note taking app, the first thing you'd want to do is create a note.

# [Desktop/Web](#/tab/web)

1. Click on the `+` button on top right corner or click anywhere inside the editor to focus it.
2. Start typing in the editor and your note will be saved.
2. Start typing in the editor and a new note will be automatically created.
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.
> The bottom right corner of the app will show the number of words of current note & the last saved time.
>
> ![Status bar desktop](/editor-status-bar-desktop.png)
# [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. As you type, your note is saved automatically whenever you stop for a few seconds.
1. On mobile regardless of what screen you are on, you can swipe from right to left to open the editor.
2. You can also press the `+` button on bottom right corner to open the editor (note: the `+` button is visible only on some screens).
3. Start typing in the editor and a new note will be automatically created.
4. 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.
> Below the note title is the editor status bar. It shows you the number of words in the note and last saved time.
---

Expand Down
6 changes: 3 additions & 3 deletions docs/help/contents/deleting-your-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ Notesnook allows you to delete your accounts and your data without any questions
1. Open Notesnook web or desktop app
2. Make sure you are logged in
3. Go to Settings
4. Scroll to the very end & click on `Delete account`
4. Click on `Delete account` button next to **Account removal** heading

## [Mobile](#/tab/mobile)

1. Open the Notesnook app
2. Make sure you are logged in
3. Go to Settings
4. Go to `Account Settings`
5. Click on `Delete account`
5. Tap on `Delete account`

---

Expand All @@ -32,4 +32,4 @@ All your notes, notebooks, attachments, and any other data that you created with

### Is there any way to recover deleted data?

No. Once you delete your account, it's gone for good and there is no way for us or anyone else to recover it. If your data is important to you, make sure to take a [backup](/backup-and-restore-notes-in-notesnook) before deleting your account or [exporting your notes](/export-notes-from-notesnook).
No. Once you delete your account, it's gone for good and there is no way for us or anyone else to recover it. If your data is important to you, make sure to take a [backup](/backup-and-restore-notes-in-notesnook) or [export your notes](/export-notes-from-notesnook) before deleting your account.
11 changes: 6 additions & 5 deletions docs/help/contents/desktop-integration/jumplist-and-dock-menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Notesnook supports quick actions from the "jumplist" menu (dock menu on macOS):

## [Windows](#/tab/windows)

![](/static/desktop-integration/jumplist-menu-windows.png)

## [Linux](#/tab/linux)

![](/static/desktop-integration/jumplist-menu-linux.png)
Expand All @@ -16,9 +18,8 @@ Notesnook supports quick actions from the "jumplist" menu (dock menu on macOS):

## How it works?

The jumplist menu doesn't work if you already have Notesnook opened. They are responsible for opening Notesnook at the specified page. For example:
Jumplist menu items are responsible for opening Notesnook at the specified page. For example:

1. Close Notesnook if you already have it opened
2. Right click on the Notesnook icon in your taskbar/dock
3. Click on "New notebook"
4. Notice how the new notebook dialog is already opened after the app starts.
1. Right click on the Notesnook icon in your taskbar/dock
2. Click on "New notebook"
3. Notice how the new notebook dialog is opened after the Notesnook app is focused
50 changes: 27 additions & 23 deletions docs/help/contents/export-notes-from-notesnook.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,23 @@ description: Notesnook is zero lock-in. You can always export and backup your no

# Exporting notes

You can export your notes as PDF, HTML, Markdown and Plain text files on desktop and mobile apps.
You can export some or all your notes as PDF, HTML, Markdown and Plain text files on all Notesnook apps.

## Exporting a single note

# [Desktop/Web](#/tab/web)

1. Right click on a note
2. Click on 'Export'
3. Select the desired format to export your note
2. Click on `Export as`
3. Select the desired format
4. Wait a few moments while your note is exported
5. Save the note in desired location
5. Save the note at your desired location

# [Mobile](#/tab/mobile)

1. Press the ![Three dot button](/three-dot-button.png) button on a note
2. Press on 'Export'
3. Select the desired format to export your note
1. Tap the ![Three dot button](/three-dot-button.png) button on a note
2. Tap on `Export`
3. Select the desired format
4. Wait a few moments while your note is exported
5. Exported notes are stored in `Notesnook/exported` folder.

Expand All @@ -31,35 +31,39 @@ You can export your notes as PDF, HTML, Markdown and Plain text files on desktop

# [Desktop/Web](#/tab/web)

1. Hold `Ctrl` & Click on a note to enter multi-selection mode
2. Select the notes you want to export then right click
3. Click on "Export as" & select your desired export format
1. Hold `Ctrl` & click on all the notes you want to export
2. Right click & click on `Export as`
3. Select your desired export format
4. Wait a few moments while your notes are exported
5. Save the note in desired location
5. Save the `.zip` file at your desired location

# [Mobile](#/tab/mobile)

1. Long press on a note item
2. Press on "Select" on the action bar to enter selection mode
3. Select the notes you want to export
4. Press on the export icon on top right corner
5. Select the desired format to export your note
6. Exported notes are stored in `Notesnook/exported` folder
1. Long press on a note to enter multi selection mode
2. Tap on all the notes you want to export
3. Press on the Export button on top right corner
4. Select the desired format
5. Exported notes are stored in `Notesnook/exported` folder

---

## Exporting all your notes

# [Desktop/Web](#/tab/web)

1. Go to Settings from Sidebar
2. Scroll down to `Backup & Restore` section
3. Click on `Backup Data` to download the `.nnbackup` file
1. Go to Settings
2. Scroll down to `Import & export` section
3. Click on `Backup & export`
4. Click on `Select format` dropdown next to `Export all notes` heading
5. Select the desired format
6. Enter account password for authentication
7. Save the `.zip` file at your desired location

# [Mobile](#/tab/mobile)

1. Go to Settings from Sidebar
2. Scroll down to `Backup and Restore`
3. Select "Export all notes"
4. Select the desired format to export your notes
5. Exported notes are stored in `Notesnook/exported` folder as a single .zip file
3. Tap on `Export all notes`
4. Select the desired format
5. Enter account password for authentication
6. Exported notes are stored in `Notesnook/exported` folder as a single .zip file
Loading

0 comments on commit 848fdda

Please sign in to comment.