add the documentation for the hardbreak extension

2020-09-10 11:35:56 +02:00
parent 254e0b042b
commit 0a8e15623b
3 changed files with 72 additions and 3 deletions
--- a/docs/src/docPages/api/extensions/hard-break.md
+++ b/docs/src/docPages/api/extensions/hard-break.md
@@ -1,9 +1,18 @@
 # HardBreak
-Enables you to use the `<br>` HTML tag in the editor.
+The HardBreak extensions adds support for the `<br>` HTML tag, which forces a line break.

 ## Options
 *None*

+## Commands
+*None*
+
 ## Keyboard shortcuts
-* `Command` + `Enter`
-* `Shift` + `Enter`
+* Windows & Linux: `Shift` + `Enter`
+* macOS: `Command` + `Enter`
+
+## Source Code
+[packages/extension-hard-break/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-hard-break/)
+
+## Usage
+<demo name="Extensions/HardBreak" highlight="13,32" />