Przeglądaj źródła

Fix links in the docs.

Maciej Gołaszewski 6 lat temu
rodzic
commit
4313ee13bc

+ 1 - 1
packages/ckeditor5-indent/LICENSE.md

@@ -1,7 +1,7 @@
 Software License Agreement
 ==========================
 
-**CKEditor 5 Indent Block Feature** – https://github.com/ckeditor/ckeditor5-indent-block <br>
+**CKEditor 5 Indent Block Feature** – https://github.com/ckeditor/ckeditor5-indent <br>
 Copyright (c) 2003-2019, [CKSource](http://cksource.com) Frederico Knabben. All rights reserved.
 
 Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html).

+ 7 - 7
packages/ckeditor5-indent/README.md

@@ -2,19 +2,19 @@ CKEditor 5 indent block feature
 ===========================
 
 [![Join the chat at https://gitter.im/ckeditor/ckeditor5](https://badges.gitter.im/ckeditor/ckeditor5.svg)](https://gitter.im/ckeditor/ckeditor5?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-indent-block.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-indent-block)
-[![Build Status](https://travis-ci.org/ckeditor/ckeditor5-indent-block.svg?branch=master)](https://travis-ci.org/ckeditor/ckeditor5-indent-block)
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-indent.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-indent)
+[![Build Status](https://travis-ci.org/ckeditor/ckeditor5-indent.svg?branch=master)](https://travis-ci.org/ckeditor/ckeditor5-indent)
 [![BrowserStack Status](https://automate.browserstack.com/automate/badge.svg?badge_key=d3hvenZqQVZERFQ5d09FWXdyT0ozVXhLaVltRFRjTTUyZGpvQWNmWVhUUT0tLUZqNlJ1YWRUd0RvdEVOaEptM1B2Q0E9PQ==--c9d3dee40b9b4471ff3fb516d9ecf8d09292c7e0)](https://automate.browserstack.com/public-build/d3hvenZqQVZERFQ5d09FWXdyT0ozVXhLaVltRFRjTTUyZGpvQWNmWVhUUT0tLUZqNlJ1YWRUd0RvdEVOaEptM1B2Q0E9PQ==--c9d3dee40b9b4471ff3fb516d9ecf8d09292c7e0)
-[![Coverage Status](https://coveralls.io/repos/github/ckeditor/ckeditor5-indent-block/badge.svg?branch=master)](https://coveralls.io/github/ckeditor/ckeditor5-indent-block?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/ckeditor/ckeditor5-indent/badge.svg?branch=master)](https://coveralls.io/github/ckeditor/ckeditor5-indent?branch=master)
 <br>
-[![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-indent-block/status.svg)](https://david-dm.org/ckeditor/ckeditor5-indent-block)
-[![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-indent-block/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-indent-block?type=dev)
+[![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-indent/status.svg)](https://david-dm.org/ckeditor/ckeditor5-indent)
+[![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-indent/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-indent?type=dev)
 
-This package implements block indentation support for CKEditor 5.
+This package implements indentation support for CKEditor 5.
 
 ## Documentation
 
-See the [`@ckeditor/ckeditor5-indent-block` package](https://ckeditor.com/docs/ckeditor5/latest/api/indent-block.html) page in [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
+See the [`@ckeditor/ckeditor5-indent` package](https://ckeditor.com/docs/ckeditor5/latest/api/indent.html) page in [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
 
 ## License
 

+ 0 - 0
packages/ckeditor5-indent/docs/_snippets/features/build-indent-block-source.html → packages/ckeditor5-indent/docs/_snippets/features/build-indent-source.html


+ 2 - 0
packages/ckeditor5-indent/docs/_snippets/features/build-indent-block-source.js → packages/ckeditor5-indent/docs/_snippets/features/build-indent-source.js

@@ -7,8 +7,10 @@
 
 import ClassicEditor from '@ckeditor/ckeditor5-build-classic/src/ckeditor';
 
+import Indent from '@ckeditor/ckeditor5-indent/src/indent';
 import IndentBlock from '@ckeditor/ckeditor5-indent/src/indentblock';
 
+ClassicEditor.builtinPlugins.push( Indent );
 ClassicEditor.builtinPlugins.push( IndentBlock );
 
 window.ClassicEditor = ClassicEditor;

+ 1 - 1
packages/ckeditor5-indent/docs/_snippets/features/indent-block.html → packages/ckeditor5-indent/docs/_snippets/features/indent.html

@@ -1,4 +1,4 @@
-<div id="snippet-indent-block">
+<div id="snippet-indent">
 	<p>
 		This paragraph has no indentation.<br>
 		Cookie chupa chups marshmallow jelly beans. Bear claw chocolate bar chupa chups oat cake caramels chupa chups oat cake marzipan. Candy chupa chups chocolate. Cake soufflé candy canes fruitcake jelly-o oat cake. Macaroon tootsie roll candy marzipan sesame snaps cupcake wafer gingerbread. Oat cake cake cake sesame snaps pastry halvah.

+ 1 - 1
packages/ckeditor5-indent/docs/_snippets/features/indent-block.js → packages/ckeditor5-indent/docs/_snippets/features/indent.js

@@ -8,7 +8,7 @@
 import { CS_CONFIG } from '@ckeditor/ckeditor5-cloud-services/tests/_utils/cloud-services-config';
 
 ClassicEditor
-	.create( document.querySelector( '#snippet-indent-block' ), {
+	.create( document.querySelector( '#snippet-indent' ), {
 		cloudServices: CS_CONFIG,
 		toolbar: {
 			items: [

+ 15 - 7
packages/ckeditor5-indent/docs/features/indent.md

@@ -3,25 +3,28 @@ title: Block indentation
 category: features
 ---
 
-{@snippet features/build-indent-block-source}
+{@snippet features/build-indent-source}
 
 ## Demo
 
-The block indentation feature allows to set indentation of text blocks like paragraphs or headings.
+The indentation feature allows to set indentation of text blocks like paragraphs or headings and lists.
 
-{@snippet features/indent-block}
+{@snippet features/indent}
 
 ## Configuring the block indentation feature
 
 ### Using offset and unit
 
-By default the block indentation is controlled by setting the indentation step offset and unit. Executing indent (or outdent) commands will increase (or decreas) current block indentation by given offset.
+By default the block indentation is controlled by setting the indentation step offset and unit. Executing indent (or outdent) commands will increase (or decrease) current block indentation by given offset.
 
-The editor ind the {@link features/indent-block#demo demo} section was configured using offset and unit:
+The editor ind the {@link features/indent#demo demo} section was configured using offset and unit:
 
 ```js
+import Indent from '@ckeditor/ckeditor5-indent/src/indent';
+
 ClassicEditor
 	.create( document.querySelector( '#editor' ), {
+		plugins: [ Indent, ... ],
 		toolbar: {
 			items: [ 'heading', '|', 'indent', 'outdent', '|', 'bulletedList', 'numberedList', '|', 'undo', 'redo' ]
 		},
@@ -39,8 +42,12 @@ ClassicEditor
 Alternatively the block indentation feature can be configured to set indentation by applying one of defined CSS classes:
 
 ```js
+import Indent from '@ckeditor/ckeditor5-indent/src/indent';
+import IndentBlock from '@ckeditor/ckeditor5-indent/src/indentblock';
+
 ClassicEditor
 	.create( document.querySelector( '#editor' ), {
+		plugins: [ Indent, IndentBlock, ... ],
 		toolbar: {
 			items: [ 'heading', '|', 'indent', 'outdent', '|', 'bulletedList', 'numberedList', '|', 'undo', 'redo' ]
 		},
@@ -97,11 +104,12 @@ npm install --save @ckeditor/ckeditor5-indent-block
 Then add it to your plugin list and the toolbar configuration:
 
 ```js
-import Font from '@ckeditor/ckeditor5-indent/src/indentblock';
+import Indent from '@ckeditor/ckeditor5-indent/src/indent';
+import IndentBlock from '@ckeditor/ckeditor5-indent/src/indentblock';
 
 ClassicEditor
 	.create( document.querySelector( '#editor' ), {
-		plugins: [ IndentBlock, ... ],
+		plugins: [ Indent, IndentBlock, ... ],
 		toolbar: [ 'indent', 'outdent', ... ]
 	} )
 	.then( ... )