Skip to content

Commit

Permalink
docs: adjust markdown shortcuts table
Browse files Browse the repository at this point in the history
  • Loading branch information
@ammarahm-ed @thecodrr
ammarahm-ed authored and thecodrr committed Jun 22, 2023
1 parent e7f4ba8 commit 915f21d
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 20 deletions.
3 changes: 2 additions & 1 deletion docs/help/contents/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Notesnook Help
description: Your complete and free guide to using Notesnook as a daily note taking app to organize your work and life while safeguarding your privacy.
---

# Welcome to Notesnook Help

Notesnook is a free (as in speech) and open source note taking app focused on user privacy & ease of use. To ensure zero knowledge principles, Notesnook encrypts everything on your device using `XChaCha20-Poly1305` & `Argon2`.
Notesnook is a free and open source note taking app focused on user privacy & ease of use. To ensure zero knowledge principles, Notesnook encrypts everything on your device using `XChaCha20-Poly1305` & `Argon2`.

Notesnook is our **proof** that privacy does _not_ (always) have to come at the cost of convenience. Our goal is to provide users peace of mind & 100% confidence that their notes are safe and secure. The decision to go fully open source is one of the most crucial steps towards that.

Expand Down
42 changes: 23 additions & 19 deletions docs/help/contents/rich-text-editor/markdown-notes-editing.md
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,28 @@
# Markdown shortcuts in notes

![Markdown notes editing with markdown shortcuts in Notesnook](/markdown-editing.gif)
![Markdown notes editing with markdown shortcuts in notes](/markdown-editing.gif)

The following markdown shortcuts are supported in the editor.

| Shortcut | Block |
| ------------------------------------------------------------------------------------- | --------------- |
| # | Heading 1 |
| ## | Heading 2 |
| ### | Heading 3 |
| #### | Heading 4 |
| ##### | Heading 5 |
| ###### | Heading 6 |
| \*\*bold text\*\* | Bold |
| \_italicized text\_ | Italic |
| > blockquote | Blockquote |
| 1. First item<br>2. Second item<br>3. Third item | Ordered list |
| - First item<br>- Second item<br>- Third item | Unordered list |
| - \[x] Write the press release<br>- [ ] Update the website<br>- [ ] Contact the media | Task list |
| \`inline code\` | Inline code |
| --- | Horizontal rule |
| \[title](https://www.example.com) | Link |
| \`\`\`<br>some code<br>\`\`\` | Codeblock |
| Block | Markdown shortcut |
| ------------------- | --------------------------------------------------------------------- |
| Heading 1 | # |
| Heading 1 | # |
| Heading 2 | ## |
| Heading 3 | ### |
| Heading 4 | #### |
| Heading 5 | ##### |
| Heading 6 | ###### |
| Bold | \*\*bold text\*\* |
| Italic | \_italicized text\_ |
| Blockquote | > blockquote |
| Ordered list | 1. First item<br>2. Second item<br>3. Third item |
| Unordered list | - First item<br>- Second item<br>- Third item |
| Task list | - \[x] Write the note<br>- [ ] Update the help<br>- [ ] Call the team |
| Inline code | \`inline code\` |
| Horizontal rule | --- |
| Link | \[title](https://www.example.com) |
| Codeblock | \`\`\`<br>some code<br>\`\`\` |
| Current Date | `/date` |
| Date Time | `/time` |
| Current Date & Time | `/now` |

0 comments on commit 915f21d

Please sign in to comment.