8
0
Anna Tomanek 8 лет назад
Родитель
Сommit
e62ac30b07

+ 1 - 1
packages/ckeditor5-markdown-gfm/README.md

@@ -8,7 +8,7 @@ GitHub Flavored Markdown support for CKEditor 5
 [![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-markdown-gfm/status.svg)](https://david-dm.org/ckeditor/ckeditor5-markdown-gfm)
 [![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-markdown-gfm/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-markdown-gfm?type=dev)
 
- More information about the project can be found at the following URL: <https://github.com/ckeditor/ckeditor5-markdown-gfm>.
+GitHub Flavored Markdown support for CKEditor 5. More information about the project can be found at the following URL: <https://github.com/ckeditor/ckeditor5-markdown-gfm>.
 
 ## License
 

+ 7 - 6
packages/ckeditor5-markdown-gfm/src/gfmdataprocessor.js

@@ -14,14 +14,14 @@ import GFMRenderer from './lib/marked/renderer';
 import converters from './lib/to-markdown/converters';
 
 /**
- * This data processor implementation uses GitHub flavored markdown as input/output data.
+ * This data processor implementation uses GitHub Flavored Markdown as input/output data.
  *
  * @implements module:engine/dataprocessor/dataprocessor~DataProcessor
  */
 export default class GFMDataProcessor {
 	constructor() {
 		/**
-		 * HTML data processor used to process HTML produced by the Markdown to HTML converter and the other way.
+		 * HTML data processor used to process HTML produced by the Markdown-to-HTML converter and the other way.
 		 *
 		 * @private
 		 * @member {module:engine/dataprocessor/htmldataprocessor~HtmlDataProcessor}
@@ -30,10 +30,10 @@ export default class GFMDataProcessor {
 	}
 
 	/**
-	 * Converts provided markdown string to view tree.
+	 * Converts the provided Markdown string to view tree.
 	 *
-	 * @param {String} data Markdown string.
-	 * @returns {module:engine/view/documentfragment~DocumentFragment} Converted view element.
+	 * @param {String} data A Markdown string.
+	 * @returns {module:engine/view/documentfragment~DocumentFragment} The converted view element.
 	 */
 	toView( data ) {
 		const html = marked.parse( data, {
@@ -48,7 +48,8 @@ export default class GFMDataProcessor {
 	}
 
 	/**
-	 * Converts provided {@link module:engine/view/documentfragment~DocumentFragment} to data format - in this case markdown string.
+	 * Converts the provided {@link module:engine/view/documentfragment~DocumentFragment} to data format &mdash; in this
+	 * case to a Markdown string.
 	 *
 	 * @param {module:engine/view/documentfragment~DocumentFragment} viewFragment
 	 * @returns {String} Markdown string.

+ 3 - 3
packages/ckeditor5-markdown-gfm/src/lib/marked/renderer.js

@@ -5,9 +5,9 @@
 
 /**
  * Original marked.js library renderer with fixes:
- * - no formatting for output HTML string - all newlines between tags are removed to create clean output,
- * - changed long string concatenations to ES5 template strings,
- * - changed code style.
+ * - No formatting for output HTML string &mdash; all newlines between tags are removed to create clean output.
+ * - Changed long string concatenations to ES5 template strings.
+ * - Changed code style.
  *
  * @see {@link https://github.com/chjj/marked#renderer} Methods description.
  * @param options