diff --git a/docs/content/images/interface/toolbar/blocks.png b/docs/content/images/interface/toolbar/blocks.png new file mode 100644 index 000000000..68430a338 Binary files /dev/null and b/docs/content/images/interface/toolbar/blocks.png differ diff --git a/docs/content/images/interface/toolbar/emoji.png b/docs/content/images/interface/toolbar/emoji.png new file mode 100644 index 000000000..93a535084 Binary files /dev/null and b/docs/content/images/interface/toolbar/emoji.png differ diff --git a/docs/content/images/interface/toolbar/emphasis.png b/docs/content/images/interface/toolbar/emphasis.png new file mode 100644 index 000000000..524751755 Binary files /dev/null and b/docs/content/images/interface/toolbar/emphasis.png differ diff --git a/docs/content/images/interface/toolbar/large_blocks.png b/docs/content/images/interface/toolbar/large_blocks.png new file mode 100644 index 000000000..85df5354b Binary files /dev/null and b/docs/content/images/interface/toolbar/large_blocks.png differ diff --git a/docs/content/images/interface/toolbar/links.png b/docs/content/images/interface/toolbar/links.png new file mode 100644 index 000000000..222d25397 Binary files /dev/null and b/docs/content/images/interface/toolbar/links.png differ diff --git a/docs/content/images/interface/toolbar/table_modal.png b/docs/content/images/interface/toolbar/table_modal.png new file mode 100644 index 000000000..abecdcd0e Binary files /dev/null and b/docs/content/images/interface/toolbar/table_modal.png differ diff --git a/docs/content/images/interface/toolbar/table_overlay.png b/docs/content/images/interface/toolbar/table_overlay.png new file mode 100644 index 000000000..e29932656 Binary files /dev/null and b/docs/content/images/interface/toolbar/table_overlay.png differ diff --git a/docs/content/images/interface/toolbar/whole.png b/docs/content/images/interface/toolbar/whole.png new file mode 100644 index 000000000..a872ff204 Binary files /dev/null and b/docs/content/images/interface/toolbar/whole.png differ diff --git a/docs/content/interface/toolbar.md b/docs/content/interface/toolbar.md new file mode 100644 index 000000000..3d6c327ac --- /dev/null +++ b/docs/content/interface/toolbar.md @@ -0,0 +1,96 @@ +# Toolbar + +![whole toolbar](../images/interface/toolbar/whole.png) + +The Toolbar is found above the editor and is split into five sections: + +1. Emphasis +2. Header & Blocks +3. Links & Images +4. Larger Blocks & Emojis +5. Settings + +## Emphasis + +![Emphasis toolbar](../images/interface/toolbar/emphasis.png) + +These buttons are able to either surround selected text with the necessary symbols to emphasize it or insert the symbols +without any content between them to be filled out by you. The icons on the buttons should be rather easy to identify. +Nonetheless, here is their functionality: + +1. bold e.g `**text**` +2. italic e.g `*text*` +3. underscore e.g `_text_` +4. strikethrough e.g `~~text~~` +5. subscript e.g `~text~` +6. superscript e.g `^text^` + +## Header & Blocks + +![Header & Blocks toolbar](../images/interface/toolbar/blocks.png) + +These buttons all work a bit different so, we will describe each on separately: + +1. **Heading** + Adds `# ` in front of the line. If the line is already starting with a `#` adds just `#`. +2. **Code Blocks** + Adds ` ``` ` around the selected text or if no text is selected just adds two lines with ` ``` ` and an empty line + between them. +3. **Quote** + Adds `> ` in front of the line. +4. **Unordered List** + Ads `- ` in front of the line. +5. **Ordered List** + Adds `1. ` in front of the line. +6. **ToDo List** + Adds `- [ ] ` in front of the line. + +## Links & Images + +![Links & Images toolbar](../images/interface/toolbar/links.png) + +These buttons add the corresponding syntax at the current cursor position. +If some text is selected it will either put that as the link, if it thinks that the selected text is a link, or as the alt text. + +1. **Link** + Adds the link template `[](https://)` (For more information + see [the markdown link documentation](https://spec.commonmark.org/0.29/#links)) +2. **Image** + Adds the image placeholder `![](https://)` (For more information + see [the markdown image documentation](https://spec.commonmark.org/0.29/#images)) +3. **Image Upload** + Asks the user to upload an image from their computer and then inserts it in the note. + +## Larger Blocks & Emojis + +![larger blocks & emojis toolbar](../images/interface/toolbar/large_blocks.png) + +1. **Table** + This button opens an overlay, which lets you choose the size of your table up to 10 columns and 8 rows. By clicking + on any of the squares a table with the corresponding size will be added to the note at the position of your cursor. + ![Table overlay](../images/interface/toolbar/table_overlay.png) + A larger table can be created by clicking the 'Custom Size' button. + ![Table modal](../images/interface/toolbar/table_modal.png) + In the modal you can specify the exact dimension of your table. +2. **Horizontal Line** + This button adds `---` at the current position of your cursor in the note. +3. **Collapsable Block** + This button adds a template for a Collapsable Block like this: + + ``` + :::spoiler Toggle label + Toggled content + ::: + ``` + +4. **Comment** + This button adds `> []` at the beginning of the line. You can either specify a name for your comment by + inserting `name=$YourName`, a time by inserting `time=$time` or a color by inserting `color=#FFFFFF` in the `[]`. + Please note that you can only specify one of those per `[]`, but you can use multiple `[]`. +5. **Emoji Picker** + This button opens the emoji picker, where you can choose an emoji or a fork awesome icon to insert into your note. + ![Emoji Picker](../images/interface/toolbar/emoji.png) + +## Settings + +ToDo diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index f6b7cb167..1851ae25b 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -7,6 +7,8 @@ docs_dir: content edit_uri: https://github.com/hedgedoc/hedgedoc/edit/master/docs/content/ nav: - Home: index.md + - Interface: + Toolbar: interface/toolbar.md - Developer: - '2.0 Development': dev/2.0.md - Configuration: dev/config.md