Mirrors/notesnook
1
0
Fork 0
mirror of https://github.com/streetwriters/notesnook.git synced 2025-12-24 23:49:33 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: migrate to new callout syntax

Browse Source
This commit is contained in:
Abdullah Atta
2023-02-03 15:30:37 +05:00
committed by Abdullah Atta
parent 723bb67a6f
commit 3ea810a059
5 changed files with 53 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/help/contents/creating-note.md
View File

@@ -14,13 +14,11 @@ You are in a notes app, the first thing you want to do is make a note.
![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 %}
> 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)
# [Mobile](#/tab/mobile)
@@ -30,11 +28,9 @@ The bottom right corner of the app will show the no. of words of current note &
![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 %}
> info
>
> Below the note title is the editor status bar. It shows you the no. of words in the note and last saved time.
---

37
docs/help/contents/encryption.md
View File

@@ -2,12 +2,9 @@
title: How is my data encrypted
---
{% warn %}
Note: This document is not a spec, only an explanation of the encryption process.
{% end %}
> warn Note
>
> This document is not a spec, only an explanation of the encryption process.
## Algorithms & cryptographic library
@@ -31,12 +28,9 @@ When you sign up for an account, the app takes your password and hashes it using
This predictable salt is generated using a `fixed client salt` + `your email`.
{% info Your password never leaves your device %}
Sending the hash over sending your plain text password ensures that there is no way for us (or anyone else) to get your password.
{% end %}
> info Your password never leaves your device
>
> Sending the hash over sending your plain text password ensures that there is no way for us (or anyone else) to get your password.
After the hash is generated, it is sent to the server. This hash is used as a `password` and is hashed again to mitigate password passthrough attacks.
@@ -46,11 +40,9 @@ This process is repeated every time you sign in.
After you are signed in, the app requests your user data which includes, among other things, your salt.
{% info Salt generation %}
When you create an account, the server generates a cryptographically secure random salt for you. This salt is used for key generation.
{% end %}
> info Salt generation
>
> When you create an account, the server generates a cryptographically secure random salt for you. This salt is used for key generation.
You password & salt is then used to derive a strong irreversible key using Argon2 as the password key derivation function (PKDF).
@@ -83,13 +75,8 @@ Encryption only takes place when you sync. Each item in the database is encrypte
4. Algorithm id `alg`
5. ItemId `id`
{% info %}
See the whole process in action [here.](https://notesnook.com/#whynotesnook)
{% end %}
> info
>
> See the whole process in action [here.](https://notesnook.com/#whynotesnook)
This object is then sent to the server for storage. The server performs no further operation on this data (because it can't).

33
docs/help/contents/organization/how-do-i-add-tags-to-notes.md
View File

@@ -15,14 +15,11 @@ Tags are a quick and simple way to organize your notes.
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 %}
> 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)
# [Mobile](#/tab/mobile)
@@ -31,17 +28,15 @@ Added tags also appear at the bottom of each note item in the notes list. Tappin
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 %}
> 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)
---

12
docs/help/contents/organization/how-do-i-organize-notes-using-colors.md
View File

@@ -23,13 +23,11 @@ Colors are a simple and quick way to organize your notes.
---
{% info %}
After you assign a color to a note, the note will adapt to that color.
![Colored note](/colored-note.png)
{% end %}
> info
>
> After you assign a color to a note, the note will adapt to that color.
>
> ![Colored note](/colored-note.png)
## Color Shortcuts

37
docs/help/contents/organization/organizing-notes-with-notebooks.md
View File

@@ -14,11 +14,9 @@ Notebooks consist of topics where you can add/create and edit your notes.
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 %}
> info
>
> Adding a description & topics are optional.
4. Click on `Create` button.
5. You have created your first notebook in Notesnook.
@@ -29,11 +27,9 @@ Adding a description & topics are optional.
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 %}
> info
>
> Adding a description & topics are optional.
4. Press the `Create notebook` button.
5. You have created your first notebook in Notesnook.
@@ -116,14 +112,11 @@ Adding a description & topics are optional.
---
{% 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 %}
> 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)
### Adding a note to a topic
@@ -147,11 +140,9 @@ Once a note is added to a notebook, it's refernence will show on top of the note
---
{% 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 %}
> info
>
> In Notesnook a single note can exist in multiple Notebooks and topics. However a note shows at most only one reference on top.
### Adding multiple notes to a topic