From 40d53720e97c407dbc039362be79ad3ec53f6dd2 Mon Sep 17 00:00:00 2001 From: MM20 <15646950+MM2-0@users.noreply.github.com> Date: Mon, 15 May 2023 14:02:02 +0200 Subject: [PATCH] Add notes widget docs --- docs/docs/user-guide/widgets/notes-widget.mdx | 48 +++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 docs/docs/user-guide/widgets/notes-widget.mdx diff --git a/docs/docs/user-guide/widgets/notes-widget.mdx b/docs/docs/user-guide/widgets/notes-widget.mdx new file mode 100644 index 00000000..4b7e41f0 --- /dev/null +++ b/docs/docs/user-guide/widgets/notes-widget.mdx @@ -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: +
+ +- `**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` + +
+ +### Export notes + +Notes can be exported as markdown files. To do so, tap the icon in the bottom right corner and select "Save". + +### Add notes + +A new instance of the notes widget can be added by tapping the in an existing notes widget and selecting "New note". + +### Dismiss notes + +Notes can be dismissed by tapping the 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. \ No newline at end of file