improve extensions documentation

This commit is contained in:
Hans Pagel
2020-08-20 15:44:08 +02:00
parent cbe8e1f357
commit ec2a6e86b3
20 changed files with 41 additions and 27 deletions

View File

@@ -18,7 +18,6 @@ The extension will generate the corresponding `<strong>` HTML tags when reading
* macOS: `Command` + `B` * macOS: `Command` + `B`
## Usage ## Usage
```markup ```markup
<template> <template>
<div> <div>

View File

@@ -17,7 +17,6 @@ Its intended to be used with the `ListItem` extension.
* `Control` + `Shift` + `8` * `Control` + `Shift` + `8`
## Usage ## Usage
```markup ```markup
<template> <template>
<div> <div>

View File

@@ -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*

View File

@@ -1,2 +1,11 @@
# CodeBlock # CodeBlock
Enables you to use the `<pre>` HTML tag in the editor. Enables you to use the `<pre>` HTML tag in the editor.
## Options
*None*
## Commands
*None*
## Keybindings
*None*

View File

@@ -1,2 +0,0 @@
# CodeBlockHighlight
Enables you to use the `<pre>` HTML tag with auto-detected syntax highlighting in the editor.

View File

@@ -5,5 +5,5 @@ Enables you to use the `<br>` HTML tag in the editor.
*None* *None*
## Keybindings ## Keybindings
* New CodeBlock: `Shift` + `Enter` + ` * `Command` + `Enter`
* Leave CodeBlock: `Command` + `Enter` * `Shift` + `Enter`

View File

@@ -1,10 +1,10 @@
# Heading # Heading
Enables you to use the headline HTML tags in the editor. Enables you to use headline HTML tags in the editor.
## Options ## 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 ## Commands
| Command | Options | Description | | Command | Options | Description |

View File

@@ -2,6 +2,6 @@
Enables you to use the `<a>` HTML tag in the editor. Enables you to use the `<a>` HTML tag in the editor.
## Options ## Options
| option | type | default | description | | Option | Type | Default | Description |
| ------ | ---- | ---- | ----- | | ------ | ---- | ---- | ----- |
| openOnClick | Boolean | true | Specifies if links will be opened on click. | | openOnClick | Boolean | true | Specifies if links will be opened on click. |

View File

@@ -7,7 +7,7 @@ Tables can be nested and allow all blocks to be used inside.
Each `<TableCell>` includes a single `<Paragraph>`. Each `<TableCell>` includes a single `<Paragraph>`.
## Options ## Options
| option | type | default | description | | Option | Type | Default | Description |
| ------ | ---- | ---- | ----- | | ------ | ---- | ---- | ----- |
| resizable | Boolean | false | Enables the resizing of columns | | resizable | Boolean | false | Enables the resizing of columns |

View File

@@ -14,7 +14,6 @@ Enables you to use the `<s>` HTML tag in the editor.
* macOS: `Command` + `D` * macOS: `Command` + `D`
## Usage ## Usage
```markup ```markup
<template> <template>
<div> <div>

View File

@@ -6,7 +6,7 @@ This extensions is intended to be used with the `TodoList` extension.
::: :::
## Options ## Options
| option | type | default | description | | Option | Type | Default | Description |
| ------ | ---- | ---- | ----- | | ------ | ---- | ---- | ----- |
| nested | Boolean | false | Specifies if you can nest todo lists. | | nested | Boolean | false | Specifies if you can nest todo lists. |

View File

@@ -14,7 +14,6 @@ Enables you to use the `<u>` HTML tag in the editor.
* macOS: `Command` + `U` * macOS: `Command` + `U`
## Usage ## Usage
```markup ```markup
<template> <template>
<div> <div>

View File

@@ -83,47 +83,47 @@
- title: Bold - title: Bold
link: /api/extensions/bold link: /api/extensions/bold
- title: BulletList - title: BulletList
link: /api/extensions/bulletlist link: /api/extensions/bullet-list
- title: Code - title: Code
link: /api/extensions/code link: /api/extensions/code
- title: CodeBlock - title: CodeBlock
link: /api/extensions/codeblock link: /api/extensions/code-block
- title: CodeBlockHeighlight - title: CodeBlockHighlight
link: /api/extensions/codeblockheighlight link: /api/extensions/code-block-highlight
- title: Collaboration - title: Collaboration
link: /api/extensions/collaboration link: /api/extensions/collaboration
- title: Hardbreak - title: Hardbreak
link: /api/extensions/hardbreak link: /api/extensions/hard-break
- title: Heading - title: Heading
link: /api/extensions/heading link: /api/extensions/heading
- title: History - title: History
link: /api/extensions/history link: /api/extensions/history
- title: HorizontalRule - title: HorizontalRule
link: /api/extensions/horizontalrule link: /api/extensions/horizontal-rule
- title: Italic - title: Italic
link: /api/extensions/italic link: /api/extensions/italic
- title: Link - title: Link
link: /api/extensions/link link: /api/extensions/link
- title: ListItem - title: ListItem
link: /api/extensions/listitem link: /api/extensions/list-item
- title: Mention - title: Mention
link: /api/extensions/mention link: /api/extensions/mention
- title: OrderedList - title: OrderedList
link: /api/extensions/orderedlist link: /api/extensions/ordered-list
- title: Placeholder - title: Placeholder
link: /api/extensions/placeholder link: /api/extensions/placeholder
- title: Strike - title: Strike
link: /api/extensions/strike link: /api/extensions/strike
- title: TableCell - title: TableCell
link: /api/extensions/tablecell link: /api/extensions/table-cell
- title: TableHeader - title: TableHeader
link: /api/extensions/tableheader link: /api/extensions/table-header
- title: TableRow - title: TableRow
link: /api/extensions/tablerow link: /api/extensions/table-row
- title: TodoItem - title: TodoItem
link: /api/extensions/todoitem link: /api/extensions/todo-item
- title: TodoList - title: TodoList
link: /api/extensions/todolist link: /api/extensions/todo-list
- title: Underline - title: Underline
link: /api/extensions/underline link: /api/extensions/underline
- title: Commands - title: Commands