Skip to content
This repository was archived by the owner on Jun 26, 2020. It is now read-only.

Commit 605edb9

Browse files
committed
Corrected the documentation.
1 parent afc7906 commit 605edb9

File tree

6 files changed

+12
-7
lines changed

6 files changed

+12
-7
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ CKEditor 5 basic styles feature
1010
[![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-basic-styles/status.svg)](https://david-dm.org/ckeditor/ckeditor5-basic-styles)
1111
[![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-basic-styles/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-basic-styles?type=dev)
1212

13-
This package contains CKEditor 5 features allowing to apply basic text formatting such as bold, italic, underline and code in CKEditor 5.
13+
This package contains CKEditor 5 features allowing to apply basic text formatting such as bold, italic, underline, and code in CKEditor 5.
1414

1515
## Demo
1616

docs/_snippets/features/basic-styles.html

+1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@
44
<p><u>This text is underlined</u>.</p>
55
<p><s>This is a strikethrough text</s>.</p>
66
<p><code>This is an inline code</code>.</p>
7+
<p>These are <sub>a subscript</sub> and <sup>a superscript</sup>.</p>
78
</div>

docs/_snippets/features/basic-styles.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ClassicEditor
1111
.create( document.querySelector( '#snippet-basic-styles' ), {
1212
toolbar: {
1313
items: [
14-
'bold', 'italic', 'underline', 'strikethrough', 'code', '|', 'undo', 'redo'
14+
'bold', 'italic', 'underline', 'strikethrough', 'subscript', 'superscript', 'code', '|', 'undo', 'redo'
1515
],
1616
viewportTopOffset: 100
1717
},

docs/_snippets/features/build-basic-styles-source.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@ import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold';
1111
import Italic from '@ckeditor/ckeditor5-basic-styles/src/italic';
1212
import Underline from '@ckeditor/ckeditor5-basic-styles/src/underline';
1313
import Strikethrough from '@ckeditor/ckeditor5-basic-styles/src/strikethrough';
14+
import Subscript from '@ckeditor/ckeditor5-basic-styles/src/subscript';
15+
import Superscript from '@ckeditor/ckeditor5-basic-styles/src/superscript';
1416
import Code from '@ckeditor/ckeditor5-basic-styles/src/code';
1517

16-
ClassicEditor.builtinPlugins.push( Bold, Italic, Underline, Strikethrough, Code );
18+
ClassicEditor.builtinPlugins.push( Bold, Italic, Underline, Strikethrough, Subscript, Superscript, Code );
1719

1820
window.ClassicEditor = ClassicEditor;

docs/api/basic-styles.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ category: api-reference
66

77
[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-basic-styles.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-basic-styles)
88

9-
This package contains features allowing to apply basic text formatting such as bold, italic, underline, strikethrough and code in CKEditor 5.
9+
This package contains features allowing to apply basic text formatting such as bold, italic, underline, strikethrough, subscript, superscript, and code in CKEditor 5.
1010

1111
## Demo
1212

@@ -22,6 +22,8 @@ You can also check out the following plugins:
2222
* {@link module:basic-styles/italic~Italic}
2323
* {@link module:basic-styles/strikethrough~Strikethrough}
2424
* {@link module:basic-styles/underline~Underline}
25+
* {@link module:basic-styles/subscript~Subscript}
26+
* {@link module:basic-styles/superscript~Superscript}
2527
* {@link module:basic-styles/code~Code}
2628

2729
## Installation

docs/features/basic-styles.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ category: features
55

66
{@snippet features/build-basic-styles-source}
77

8-
The {@link api/basic-styles basic styles} package provides text formatting features such as bold, italic, underline, strikethrough and code.
8+
The {@link api/basic-styles basic styles} package provides text formatting features such as bold, italic, underline, strikethrough, subscript, superscript, and code.
99

1010
## Demo
1111

@@ -38,8 +38,8 @@ By default, each feature can upcast more than one type of the content. Here's th
3838
| {@link module:basic-styles/underline~Underline} | `<u>`, `<* style="text-decoration: underline">` |
3939
| {@link module:basic-styles/strikethrough~Strikethrough} | `<s>`, `<del>`, `<strike>`, `<* style="text-decoration: line-through">` |
4040
| {@link module:basic-styles/code~Code} | `<code>`, `<* style="word-wrap: break-word">` |
41-
| {@link module:basic-styles/subscript~Subscript} | `<sub>`, `<* style="vertical-align:sub">` |
42-
| {@link module:basic-styles/superscript~Superscript} | `<sup>`, `<* style="vertical-align:super">` |
41+
| {@link module:basic-styles/subscript~Subscript} | `<sub>`, `<* style="vertical-align: sub">` |
42+
| {@link module:basic-styles/superscript~Superscript} | `<sup>`, `<* style="vertical-align: super">` |
4343

4444
## Installation
4545

0 commit comments

Comments
 (0)