From 9244c3e912badbc640b117125f8afc670ea614e9 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Wed, 9 Sep 2020 16:15:22 +0200 Subject: [PATCH] add the custom class option to all extensions that generate HTML tags --- docs/src/docPages/api/extensions/blockquote.md | 4 +++- docs/src/docPages/api/extensions/bold.md | 4 +++- docs/src/docPages/api/extensions/bullet-list.md | 4 +++- docs/src/docPages/api/extensions/code.md | 4 +++- docs/src/docPages/api/extensions/heading.md | 3 ++- docs/src/docPages/api/extensions/horizontal-rule.md | 4 +++- docs/src/docPages/api/extensions/italic.md | 4 +++- docs/src/docPages/api/extensions/link.md | 5 +++-- docs/src/docPages/api/extensions/list-item.md | 7 ++++++- docs/src/docPages/api/extensions/ordered-list.md | 4 +++- docs/src/docPages/api/extensions/paragraph.md | 4 +++- docs/src/docPages/api/extensions/strike.md | 4 +++- docs/src/docPages/api/extensions/todo-item.md | 2 +- docs/src/docPages/api/extensions/underline.md | 4 +++- 14 files changed, 42 insertions(+), 15 deletions(-) diff --git a/docs/src/docPages/api/extensions/blockquote.md b/docs/src/docPages/api/extensions/blockquote.md index 0e899d1f..232e6b8c 100644 --- a/docs/src/docPages/api/extensions/blockquote.md +++ b/docs/src/docPages/api/extensions/blockquote.md @@ -2,7 +2,9 @@ The Blockquote extension enables you to use the `
` HTML tag in the editor. ## Options -*None* +| Option | Type | Default | Description | +| ------ | ---- | ------- | ----------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands | Command | Options | Description | diff --git a/docs/src/docPages/api/extensions/bold.md b/docs/src/docPages/api/extensions/bold.md index fb29a364..f45b469b 100644 --- a/docs/src/docPages/api/extensions/bold.md +++ b/docs/src/docPages/api/extensions/bold.md @@ -6,7 +6,9 @@ The extension will generate the corresponding `` HTML tags when reading ::: ## Options -*None* +| Option | Type | Default | Description | +| ------ | ---- | ------- | ----------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands | Command | Options | Description | diff --git a/docs/src/docPages/api/extensions/bullet-list.md b/docs/src/docPages/api/extensions/bullet-list.md index d547079b..3f50c95b 100644 --- a/docs/src/docPages/api/extensions/bullet-list.md +++ b/docs/src/docPages/api/extensions/bullet-list.md @@ -6,7 +6,9 @@ It’s intended to be used with the `ListItem` extension. ::: ## Options -*None* +| Option | Type | Default | Description | +| ------ | ---- | ------- | ----------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands | Command | Options | Description | diff --git a/docs/src/docPages/api/extensions/code.md b/docs/src/docPages/api/extensions/code.md index f337ce74..5e1056c0 100644 --- a/docs/src/docPages/api/extensions/code.md +++ b/docs/src/docPages/api/extensions/code.md @@ -2,7 +2,9 @@ The Code extensions enables you to use the `` HTML tag in the editor. If you paste in text with `` tags it will rendered accordingly. ## Options -*None* +| Option | Type | Default | Description | +| ------ | ---- | ------- | ----------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands | Command | Options | Description | diff --git a/docs/src/docPages/api/extensions/heading.md b/docs/src/docPages/api/extensions/heading.md index 54485c51..9f6dd4f0 100644 --- a/docs/src/docPages/api/extensions/heading.md +++ b/docs/src/docPages/api/extensions/heading.md @@ -3,7 +3,8 @@ Enables you to use headline HTML tags in the editor. ## Options | Option | Type | Default | Description | -| ------ | ---- | ---- | ----- | +| ------ | ---- | ------- | ----------- | +| class | string | – | Add a custom class to the rendered HTML tag. | | levels | Array | [1, 2, 3, 4, 5, 6] | Specifies which headlines are supported. | ## Commands diff --git a/docs/src/docPages/api/extensions/horizontal-rule.md b/docs/src/docPages/api/extensions/horizontal-rule.md index d70138b4..4c55369d 100644 --- a/docs/src/docPages/api/extensions/horizontal-rule.md +++ b/docs/src/docPages/api/extensions/horizontal-rule.md @@ -2,7 +2,9 @@ Enables you to use the `
` HTML tag in the editor. ## Options -*None* +| Option | Type | Default | Description | +| ------ | ---- | ------- | ----------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands | Command | Options | Description | diff --git a/docs/src/docPages/api/extensions/italic.md b/docs/src/docPages/api/extensions/italic.md index 7c6dbe93..c9387a39 100644 --- a/docs/src/docPages/api/extensions/italic.md +++ b/docs/src/docPages/api/extensions/italic.md @@ -6,7 +6,9 @@ The extension will generate the corresponding `` HTML tags when reading cont ::: ## Options -*None* +| Option | Type | Default | Description | +| ------ | ---- | ------- | ----------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands | Command | Options | Description | diff --git a/docs/src/docPages/api/extensions/link.md b/docs/src/docPages/api/extensions/link.md index 13f0be23..8d1e9c4a 100644 --- a/docs/src/docPages/api/extensions/link.md +++ b/docs/src/docPages/api/extensions/link.md @@ -3,5 +3,6 @@ Enables you to use the `` HTML tag in the editor. ## Options | Option | Type | Default | Description | -| ------ | ---- | ---- | ----- | -| openOnClick | Boolean | true | Specifies if links will be opened on click. | \ No newline at end of file +| ------ | ---- | ------- | ----------- | +| class | string | – | Add a custom class to the rendered HTML tag. | +| openOnClick | Boolean | true | Specifies if links will be opened on click. | diff --git a/docs/src/docPages/api/extensions/list-item.md b/docs/src/docPages/api/extensions/list-item.md index 8d3dc689..7e25bca6 100644 --- a/docs/src/docPages/api/extensions/list-item.md +++ b/docs/src/docPages/api/extensions/list-item.md @@ -3,4 +3,9 @@ Enables you to use the `
  • ` HTML tag in the editor. ::: warning Restrictions This extensions is intended to be used with the `BulletList` or `OrderedList` extension. -::: \ No newline at end of file +::: + +## Options +| Option | Type | Default | Description | +| ------ | ---- | ------- | ----------- | +| class | string | – | Add a custom class to the rendered HTML tag. | \ No newline at end of file diff --git a/docs/src/docPages/api/extensions/ordered-list.md b/docs/src/docPages/api/extensions/ordered-list.md index 390c2c40..97dec2f9 100644 --- a/docs/src/docPages/api/extensions/ordered-list.md +++ b/docs/src/docPages/api/extensions/ordered-list.md @@ -6,7 +6,9 @@ This extensions is intended to be used with the `ListItem` extension. ::: ## Options -*None* +| Option | Type | Default | Description | +| ------ | ---- | ------- | ----------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands | Command | Options | Description | diff --git a/docs/src/docPages/api/extensions/paragraph.md b/docs/src/docPages/api/extensions/paragraph.md index c54fde67..4a8b7d9d 100644 --- a/docs/src/docPages/api/extensions/paragraph.md +++ b/docs/src/docPages/api/extensions/paragraph.md @@ -2,7 +2,9 @@ Enables you to use paragraphs in the editor. ## Options -*None* +| Option | Type | Default | Description | +| ------ | ---- | ------- | ----------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands *None* diff --git a/docs/src/docPages/api/extensions/strike.md b/docs/src/docPages/api/extensions/strike.md index 463de394..51afcf90 100644 --- a/docs/src/docPages/api/extensions/strike.md +++ b/docs/src/docPages/api/extensions/strike.md @@ -2,7 +2,9 @@ Enables you to use the `` HTML tag in the editor. ## Options -*None* +| Option | Type | Default | Description | +| ------ | ---- | ------- | ----------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands | Command | Options | Description | diff --git a/docs/src/docPages/api/extensions/todo-item.md b/docs/src/docPages/api/extensions/todo-item.md index 5896231b..aa6756ef 100644 --- a/docs/src/docPages/api/extensions/todo-item.md +++ b/docs/src/docPages/api/extensions/todo-item.md @@ -7,7 +7,7 @@ This extensions is intended to be used with the `TodoList` extension. ## Options | Option | Type | Default | Description | -| ------ | ---- | ---- | ----- | +| ------ | ---- | ------- | ----------- | | nested | Boolean | false | Specifies if you can nest todo lists. | ## Commands diff --git a/docs/src/docPages/api/extensions/underline.md b/docs/src/docPages/api/extensions/underline.md index 8e639900..e1626cad 100644 --- a/docs/src/docPages/api/extensions/underline.md +++ b/docs/src/docPages/api/extensions/underline.md @@ -2,7 +2,9 @@ Enables you to use the `` HTML tag in the editor. ## Options -*None* +| Option | Type | Default | Description | +| ------ | ---- | ------- | ----------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands | Command | Options | Description |