8
0
Эх сурвалжийг харах

Docs: Added feature guide.

Piotrek Koszuliński 8 жил өмнө
parent
commit
3b14f24101

+ 65 - 0
packages/ckeditor5-autoformat/docs/autoformat.md

@@ -0,0 +1,65 @@
+---
+title: Autoformatting
+category: features
+---
+
+The {@link module:autoformat/autoformat~Auformat} feature allows you to quickly apply formatting to the content you're writing.
+
+<info-box info>
+	This feature is enabled by default in all builds. It is also included in the {@link module:presets/article~Article Article preset}.
+</info-box>
+
+## Block formatting
+
+* Start a line with `*` or `-` followed by a space to create a bulleted list.
+* Start a line with `1.` or `1)` followed by a space to create a numbered list.
+* Start a line with `#` or `##` or `###` followed by a space to create a heading 1, heading 2 or heading 3 (up to heading 6 if {@link module:heading/heading~HeadingConfig#options} defines more headings).
+* Start a line with `>` followed by a space to create a block quote.
+
+## Inline formatting
+
+* Type `**text**` or `__text__` to make "text" bold.
+* Type `*text*` or `_text_` to make "text" italic.
+
+## Test here
+
+Example:
+
+1. Delete all content.
+2. Press <kbd>#</kbd> and then <kbd>Space</kbd>.
+3. The current line will be turned into a heading.
+
+{@snippet examples/classic-editor}
+
+## Installation
+
+To add this feature to your editor install the [`@ckeditor/ckeditor5-autoformat`](https://www.npmjs.com/package/@ckeditor/ckeditor5-autoformat) package:
+
+```
+npm install --save @ckeditor/ckeditor5-autoformat
+```
+
+And add it to your plugin list:
+
+```js
+import Autoformat from '@ckeditor/ckeditor5-autoformat/src/autoformat';
+
+ClassicEditor
+	.create( {
+		plugins: [ Autoformat, ... ]
+	} )
+	.then( ... )
+	.catch( ... );
+```
+
+If you are using editor build see how to {@linkTODO customize builds}.
+
+## Create your own autoformatters
+
+The {@link module:autoformat/autoformat~Auformat} feature bases on {@link module:autoformat/blockautoformatengine~BlockAuformatEngine} and {@link module:autoformat/inlineautoformatengine~InlineAuformatEngine} tools to create the autoformatters mentioned above.
+
+You can use these tools to create your own autoformatters. Check the [`Autformat` feature's code](https://github.com/ckeditor/ckeditor5-autoformat/blob/master/src/autoformat.js) as an example.
+
+## Contribute
+
+The source code of the feature is available on GitHub in https://github.com/ckeditor/ckeditor5-autoformat.

+ 0 - 6
packages/ckeditor5-autoformat/docs/guides/plugins/get-started.md

@@ -1,6 +0,0 @@
----
-title: Autoformat Guide
-category: plugins
-order: 10
----
-Lorem ipsum dolor sit amet, consectetur adipiscing elit.