Преглед изворни кода

Docs: Package page and README. [skip ci]

Piotrek Koszuliński пре 8 година
родитељ
комит
fb210ddd67
2 измењених фајлова са 34 додато и 3 уклоњено
  1. 30 0
      packages/ckeditor5-heading/docs/api/heading.md
  2. 4 3
      packages/ckeditor5-heading/src/heading.js

+ 30 - 0
packages/ckeditor5-heading/docs/api/heading.md

@@ -0,0 +1,30 @@
+---
+category: api-reference
+---
+
+# CKEditor 5 headings feature
+
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-heading.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-heading)
+
+This package implements headings feature.
+
+## Documentation
+
+See the {@link features/headings Headings feature} guide and the {@link module:heading/heading~Heading} plugin documentation.
+
+## Installation
+
+```bash
+npm install --save @ckeditor/ckeditor5-heading
+```
+
+## Contribute
+
+The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5-heading.
+
+## External links
+
+* [`@ckeditor/ckeditor5-heading` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-heading)
+* [`ckeditor/ckeditor5-heading` on GitHub](https://github.com/ckeditor/ckeditor5-heading)
+* [Issue tracker](https://github.com/ckeditor/ckeditor5-heading/issues)
+* [Changelog](https://github.com/ckeditor/ckeditor5-heading/blob/master/CHANGELOG.md)

+ 4 - 3
packages/ckeditor5-heading/src/heading.js

@@ -18,9 +18,10 @@ import Template from '@ckeditor/ckeditor5-ui/src/template';
 import '../theme/theme.scss';
 import '../theme/theme.scss';
 
 
 /**
 /**
- * The headings feature. It introduces the `headings` drop-down list and the `heading` command which allow
- * to convert paragraphs into headings. For a detailed overview, check the
- * {@glink features/headings Headings feature documentation}.
+ * The headings feature. It introduces the `headings` drop-down and the `heading1`-`headingN` commands which allow
+ * to convert paragraphs into headings.
+ *
+ * For a detailed overview, check the {@glink features/headings Headings feature documentation}.
  *
  *
  * @extends module:core/plugin~Plugin
  * @extends module:core/plugin~Plugin
  */
  */