From ec2a6e86b3f4345771b1d5bc49a5b18d854bcc00 Mon Sep 17 00:00:00 2001
From: Hans Pagel <hans.pagel@ueber.io>
Date: Thu, 20 Aug 2020 15:44:08 +0200
Subject: [PATCH] improve extensions documentation

---
 docs/src/docPages/api/extensions/bold.md      |  1 -
 .../{bulletlist.md => bullet-list.md}         |  1 -
 .../api/extensions/code-block-highlight.md    | 11 ++++++++
 .../{codeblock.md => code-block.md}           |  9 +++++++
 .../api/extensions/codeblockheighlight.md     |  2 --
 .../{hardbreak.md => hard-break.md}           |  4 +--
 docs/src/docPages/api/extensions/heading.md   |  6 ++---
 .../{horizontalrule.md => horizontal-rule.md} |  0
 docs/src/docPages/api/extensions/link.md      |  2 +-
 .../extensions/{listitem.md => list-item.md}  |  0
 .../{orderedlist.md => ordered-list.md}       |  0
 .../docPages/api/extensions/placeholder.md    |  2 +-
 docs/src/docPages/api/extensions/strike.md    |  1 -
 .../{tablecell.md => table-cell.md}           |  0
 .../{tableheader.md => table-header.md}       |  0
 .../extensions/{tablerow.md => table-row.md}  |  0
 .../extensions/{todoitem.md => todo-item.md}  |  2 +-
 .../extensions/{todolist.md => todo-list.md}  |  0
 docs/src/docPages/api/extensions/underline.md |  1 -
 docs/src/links.yaml                           | 26 +++++++++----------
 20 files changed, 41 insertions(+), 27 deletions(-)
 rename docs/src/docPages/api/extensions/{bulletlist.md => bullet-list.md} (99%)
 create mode 100644 docs/src/docPages/api/extensions/code-block-highlight.md
 rename docs/src/docPages/api/extensions/{codeblock.md => code-block.md} (52%)
 delete mode 100644 docs/src/docPages/api/extensions/codeblockheighlight.md
 rename docs/src/docPages/api/extensions/{hardbreak.md => hard-break.md} (56%)
 rename docs/src/docPages/api/extensions/{horizontalrule.md => horizontal-rule.md} (100%)
 rename docs/src/docPages/api/extensions/{listitem.md => list-item.md} (100%)
 rename docs/src/docPages/api/extensions/{orderedlist.md => ordered-list.md} (100%)
 rename docs/src/docPages/api/extensions/{tablecell.md => table-cell.md} (100%)
 rename docs/src/docPages/api/extensions/{tableheader.md => table-header.md} (100%)
 rename docs/src/docPages/api/extensions/{tablerow.md => table-row.md} (100%)
 rename docs/src/docPages/api/extensions/{todoitem.md => todo-item.md} (88%)
 rename docs/src/docPages/api/extensions/{todolist.md => todo-list.md} (100%)

diff --git a/docs/src/docPages/api/extensions/bold.md b/docs/src/docPages/api/extensions/bold.md
index cf541c24..fb0e0ab2 100644
--- a/docs/src/docPages/api/extensions/bold.md
+++ b/docs/src/docPages/api/extensions/bold.md
@@ -18,7 +18,6 @@ The extension will generate the corresponding `<strong>` HTML tags when reading
 * macOS: `Command` + `B`
 
 ## Usage
-
 ```markup
 <template>
   <div>
diff --git a/docs/src/docPages/api/extensions/bulletlist.md b/docs/src/docPages/api/extensions/bullet-list.md
similarity index 99%
rename from docs/src/docPages/api/extensions/bulletlist.md
rename to docs/src/docPages/api/extensions/bullet-list.md
index 8c85b190..a3f2738f 100644
--- a/docs/src/docPages/api/extensions/bulletlist.md
+++ b/docs/src/docPages/api/extensions/bullet-list.md
@@ -17,7 +17,6 @@ It’s intended to be used with the `ListItem` extension.
 * `Control` + `Shift` + `8`
 
 ## Usage
-
 ```markup
 <template>
   <div>
diff --git a/docs/src/docPages/api/extensions/code-block-highlight.md b/docs/src/docPages/api/extensions/code-block-highlight.md
new file mode 100644
index 00000000..80cce042
--- /dev/null
+++ b/docs/src/docPages/api/extensions/code-block-highlight.md
@@ -0,0 +1,11 @@
+# CodeBlockHighlight
+Enables you to use the `<pre>` HTML tag with auto-detected syntax highlighting in the editor.
+
+## Options
+*None*
+
+## Commands
+*None*
+
+## Keybindings
+*None*
\ No newline at end of file
diff --git a/docs/src/docPages/api/extensions/codeblock.md b/docs/src/docPages/api/extensions/code-block.md
similarity index 52%
rename from docs/src/docPages/api/extensions/codeblock.md
rename to docs/src/docPages/api/extensions/code-block.md
index fad8b4a3..71e3b08d 100644
--- a/docs/src/docPages/api/extensions/codeblock.md
+++ b/docs/src/docPages/api/extensions/code-block.md
@@ -1,2 +1,11 @@
 # CodeBlock
 Enables you to use the `<pre>` HTML tag in the editor.
+
+## Options
+*None*
+
+## Commands
+*None*
+
+## Keybindings
+*None*
\ No newline at end of file
diff --git a/docs/src/docPages/api/extensions/codeblockheighlight.md b/docs/src/docPages/api/extensions/codeblockheighlight.md
deleted file mode 100644
index 53411a4b..00000000
--- a/docs/src/docPages/api/extensions/codeblockheighlight.md
+++ /dev/null
@@ -1,2 +0,0 @@
-# CodeBlockHighlight
-Enables you to use the `<pre>` HTML tag with auto-detected syntax highlighting in the editor.
\ No newline at end of file
diff --git a/docs/src/docPages/api/extensions/hardbreak.md b/docs/src/docPages/api/extensions/hard-break.md
similarity index 56%
rename from docs/src/docPages/api/extensions/hardbreak.md
rename to docs/src/docPages/api/extensions/hard-break.md
index 4d81abd9..9e1e84ac 100644
--- a/docs/src/docPages/api/extensions/hardbreak.md
+++ b/docs/src/docPages/api/extensions/hard-break.md
@@ -5,5 +5,5 @@ Enables you to use the `<br>` HTML tag in the editor.
 *None*
 
 ## Keybindings
-* New CodeBlock: `Shift` + `Enter` + `
-* Leave CodeBlock: `Command` + `Enter`
\ No newline at end of file
+* `Command` + `Enter`
+* `Shift` + `Enter`
\ No newline at end of file
diff --git a/docs/src/docPages/api/extensions/heading.md b/docs/src/docPages/api/extensions/heading.md
index 1722819c..54485c51 100644
--- a/docs/src/docPages/api/extensions/heading.md
+++ b/docs/src/docPages/api/extensions/heading.md
@@ -1,10 +1,10 @@
 # Heading
-Enables you to use the headline HTML tags in the editor.
+Enables you to use headline HTML tags in the editor.
 
 ## Options
-| option | type | default | description |
+| Option | Type | Default | Description |
 | ------ | ---- | ---- | ----- |
-| levels | Array | [1, 2, 3, 4, 5, 6] | Specifies which headlines are to be supported. |
+| levels | Array | [1, 2, 3, 4, 5, 6] | Specifies which headlines are supported. |
 
 ## Commands
 | Command | Options | Description |
diff --git a/docs/src/docPages/api/extensions/horizontalrule.md b/docs/src/docPages/api/extensions/horizontal-rule.md
similarity index 100%
rename from docs/src/docPages/api/extensions/horizontalrule.md
rename to docs/src/docPages/api/extensions/horizontal-rule.md
diff --git a/docs/src/docPages/api/extensions/link.md b/docs/src/docPages/api/extensions/link.md
index 900cf2dc..13f0be23 100644
--- a/docs/src/docPages/api/extensions/link.md
+++ b/docs/src/docPages/api/extensions/link.md
@@ -2,6 +2,6 @@
 Enables you to use the `<a>` HTML tag in the editor.
 
 ## Options
-| option | type | default | description |
+| Option | Type | Default | Description |
 | ------ | ---- | ---- | ----- |
 | openOnClick | Boolean | true | Specifies if links will be opened on click. |
\ No newline at end of file
diff --git a/docs/src/docPages/api/extensions/listitem.md b/docs/src/docPages/api/extensions/list-item.md
similarity index 100%
rename from docs/src/docPages/api/extensions/listitem.md
rename to docs/src/docPages/api/extensions/list-item.md
diff --git a/docs/src/docPages/api/extensions/orderedlist.md b/docs/src/docPages/api/extensions/ordered-list.md
similarity index 100%
rename from docs/src/docPages/api/extensions/orderedlist.md
rename to docs/src/docPages/api/extensions/ordered-list.md
diff --git a/docs/src/docPages/api/extensions/placeholder.md b/docs/src/docPages/api/extensions/placeholder.md
index a5b1dc87..00c68d7c 100644
--- a/docs/src/docPages/api/extensions/placeholder.md
+++ b/docs/src/docPages/api/extensions/placeholder.md
@@ -7,7 +7,7 @@ Tables can be nested and allow all blocks to be used inside.
 Each `<TableCell>` includes a single `<Paragraph>`.
 
 ## Options
-| option | type | default | description |
+| Option | Type | Default | Description |
 | ------ | ---- | ---- | ----- |
 | resizable | Boolean | false | Enables the resizing of columns |
 
diff --git a/docs/src/docPages/api/extensions/strike.md b/docs/src/docPages/api/extensions/strike.md
index f6bdc40f..b19bc52d 100644
--- a/docs/src/docPages/api/extensions/strike.md
+++ b/docs/src/docPages/api/extensions/strike.md
@@ -14,7 +14,6 @@ Enables you to use the `<s>` HTML tag in the editor.
 * macOS: `Command` + `D`
 
 ## Usage
-
 ```markup
 <template>
   <div>
diff --git a/docs/src/docPages/api/extensions/tablecell.md b/docs/src/docPages/api/extensions/table-cell.md
similarity index 100%
rename from docs/src/docPages/api/extensions/tablecell.md
rename to docs/src/docPages/api/extensions/table-cell.md
diff --git a/docs/src/docPages/api/extensions/tableheader.md b/docs/src/docPages/api/extensions/table-header.md
similarity index 100%
rename from docs/src/docPages/api/extensions/tableheader.md
rename to docs/src/docPages/api/extensions/table-header.md
diff --git a/docs/src/docPages/api/extensions/tablerow.md b/docs/src/docPages/api/extensions/table-row.md
similarity index 100%
rename from docs/src/docPages/api/extensions/tablerow.md
rename to docs/src/docPages/api/extensions/table-row.md
diff --git a/docs/src/docPages/api/extensions/todoitem.md b/docs/src/docPages/api/extensions/todo-item.md
similarity index 88%
rename from docs/src/docPages/api/extensions/todoitem.md
rename to docs/src/docPages/api/extensions/todo-item.md
index 4896cf45..5896231b 100644
--- a/docs/src/docPages/api/extensions/todoitem.md
+++ b/docs/src/docPages/api/extensions/todo-item.md
@@ -6,7 +6,7 @@ This extensions is intended to be used with the `TodoList` extension.
 :::
 
 ## Options
-| option | type | default | description |
+| Option | Type | Default | Description |
 | ------ | ---- | ---- | ----- |
 | nested | Boolean | false | Specifies if you can nest todo lists. |
 
diff --git a/docs/src/docPages/api/extensions/todolist.md b/docs/src/docPages/api/extensions/todo-list.md
similarity index 100%
rename from docs/src/docPages/api/extensions/todolist.md
rename to docs/src/docPages/api/extensions/todo-list.md
diff --git a/docs/src/docPages/api/extensions/underline.md b/docs/src/docPages/api/extensions/underline.md
index aedb2aeb..6ff6419b 100644
--- a/docs/src/docPages/api/extensions/underline.md
+++ b/docs/src/docPages/api/extensions/underline.md
@@ -14,7 +14,6 @@ Enables you to use the `<u>` HTML tag in the editor.
 * macOS: `Command` + `U`
 
 ## Usage
-
 ```markup
 <template>
   <div>
diff --git a/docs/src/links.yaml b/docs/src/links.yaml
index 9bd67709..309b5345 100644
--- a/docs/src/links.yaml
+++ b/docs/src/links.yaml
@@ -83,47 +83,47 @@
         - title: Bold
           link: /api/extensions/bold
         - title: BulletList
-          link: /api/extensions/bulletlist
+          link: /api/extensions/bullet-list
         - title: Code
           link: /api/extensions/code
         - title: CodeBlock
-          link: /api/extensions/codeblock
-        - title: CodeBlockHeighlight
-          link: /api/extensions/codeblockheighlight
+          link: /api/extensions/code-block
+        - title: CodeBlockHighlight
+          link: /api/extensions/code-block-highlight
         - title: Collaboration
           link: /api/extensions/collaboration
         - title: Hardbreak
-          link: /api/extensions/hardbreak
+          link: /api/extensions/hard-break
         - title: Heading
           link: /api/extensions/heading
         - title: History
           link: /api/extensions/history
         - title: HorizontalRule
-          link: /api/extensions/horizontalrule
+          link: /api/extensions/horizontal-rule
         - title: Italic
           link: /api/extensions/italic
         - title: Link
           link: /api/extensions/link
         - title: ListItem
-          link: /api/extensions/listitem
+          link: /api/extensions/list-item
         - title: Mention
           link: /api/extensions/mention
         - title: OrderedList
-          link: /api/extensions/orderedlist
+          link: /api/extensions/ordered-list
         - title: Placeholder
           link: /api/extensions/placeholder
         - title: Strike
           link: /api/extensions/strike
         - title: TableCell
-          link: /api/extensions/tablecell
+          link: /api/extensions/table-cell
         - title: TableHeader
-          link: /api/extensions/tableheader
+          link: /api/extensions/table-header
         - title: TableRow
-          link: /api/extensions/tablerow
+          link: /api/extensions/table-row
         - title: TodoItem
-          link: /api/extensions/todoitem
+          link: /api/extensions/todo-item
         - title: TodoList
-          link: /api/extensions/todolist
+          link: /api/extensions/todo-list
         - title: Underline
           link: /api/extensions/underline
     - title: Commands