Add notes widget docs

This commit is contained in:
MM20 2023-05-15 14:02:02 +02:00
parent cf247d44be
commit 40d53720e9
No known key found for this signature in database
GPG Key ID: 0B61A8F2DEAFA389

View File

@ -0,0 +1,48 @@
import MoreVertRoundedIcon from '@mui/icons-material/MoreVertRounded'
# Notes Widget
The notes widget allows you to write down quick notes on your home screen. It is not enabled by
default, but you can add it by tapping on the "Edit widgets" button at the bottom of the home screen
and selecting "Add widget" > "Notes".
## Usage
### Editing
The notes widget consists of a text field that you can use to write down notes. Basic markdown
syntax is supported:
<details>
- `**Bold**`
- `*Italic*`
- `` `Monospace` ``
- `# Heading 1`
- `## Heading 2`
- `### Heading 3`
- `#### Heading 4`
- `##### Heading 5`
- `###### Heading 6`
- `--- Horizontal rule`
- `> Quote`
- ` ``` Code block ``` `
- `- List item`
- `1. Ordered list item`
- `- [ ] Unchecked task`
- `- [x] Checked task`
</details>
### Export notes
Notes can be exported as markdown files. To do so, tap the <MoreVertRoundedIcon /> icon in the bottom right corner and select "Save".
### Add notes
A new instance of the notes widget can be added by tapping the <MoreVertRoundedIcon /> in an existing notes widget and selecting "New note".
### Dismiss notes
Notes can be dismissed by tapping the <MoreVertRoundedIcon /> icon in the bottom right corner and
selecting "Dismiss". If you dismiss a note, the widget will be removed, unless it is the last instance
of a note widget. In this case the note widget's content will be cleared instead.