@ckeditor/ckeditor5-markdown-gfm 0.0.0-nightly-20240117.0 → 0.0.0-nightly-20240119.0

package/README.md

@@ -9,11 +9,12 @@ This package implements the GitHub Flavored Markdown data processor for CKEditor
 
 ## Demo
 
-Check out the [demo in the Markdown output feature guide](https://ckeditor.com/docs/ckeditor5/latest/features/markdown.html#demo).
+Check out the [demo in the Markdown output feature guide](https://ckeditor.com/docs/ckeditor5/latest/features/markdown.html#demo) to see the editor configured to input and output Markdown code. Use the [demo in the Paste Markdown feature guide](https://ckeditor.com/docs/ckeditor5/latest/features/pasting/paste-markdown.html#demo) to try out experimental pasting Markdown-formatted content straight into the editor.
 
 ## Documentation
 
-See the [`@ckeditor/ckeditor5-markdown-gfm` package](https://ckeditor.com/docs/ckeditor5/latest/api/markdown-gfm.html) page in [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
+See the [`@ckeditor/ckeditor5-markdown-gfm` package](https://ckeditor.com/docs/ckeditor5/latest/api/markdown-gfm.html) page as well as the [Markdown output](https://ckeditor.com/docs/ckeditor5/latest/features/markdown.html) and [Paste Markdown](https://ckeditor.com/docs/ckeditor5/latest/features/pasting/paste-markdown.html) in [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
+
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-markdown-gfm",
-  "version": "0.0.0-nightly-20240117.0",
+  "version": "0.0.0-nightly-20240119.0",
   "description": "GitHub Flavored Markdown data processor for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -13,7 +13,7 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "0.0.0-nightly-20240117.0",
+    "ckeditor5": "0.0.0-nightly-20240119.0",
     "marked": "4.0.12",
     "turndown": "6.0.0",
     "turndown-plugin-gfm": "1.0.2"

package/src/pastefrommarkdownexperimental.d.ts

@@ -34,23 +34,23 @@ export default class PasteFromMarkdownExperimental extends Plugin {
      */
     init(): void;
     /**
-     * Determines if code copied from a website in `text/html` type can be parsed as markdown.
-     * It removes any OS specific HTML tags e.g. <meta> on Mac OS and <!--StartFragment--> on Windows.
+     * Determines if the code copied from a website in the `text/html` type can be parsed as Markdown.
+     * It removes any OS-specific HTML tags, for example, <meta> on macOS and <!--StartFragment--> on Windows.
      * Then removes a single wrapper HTML tag or wrappers for sibling tags, and if there are no more tags left,
-     * returns the remaining text. Returns null, if there are any remaining HTML tags detected.
+     * returns the remaining text. Returns null if there are any remaining HTML tags detected.
      *
-     * @param htmlString Clipboard content in `text/html` type format.
+     * @param htmlString Clipboard content in the `text/html` type format.
      */
     private _parseMarkdownFromHtml;
     /**
-     * Removes OS specific tags.
+     * Removes OS-specific tags.
      *
-     * @param htmlString Clipboard content in `text/html` type format.
+     * @param htmlString Clipboard content in the `text/html` type format.
      */
     private _removeOsSpecificTags;
     /**
-     * If the input HTML string contains any first level formatting tags
-     * like <b>, <strong> or <i>, then we should not treat it as markdown.
+     * If the input HTML string contains any first-level formatting tags
+     * like <b>, <strong>, or <i>, we should not treat it as Markdown.
      *
      * @param htmlString Clipboard content.
      */
@@ -58,11 +58,11 @@ export default class PasteFromMarkdownExperimental extends Plugin {
     /**
      * Removes multiple HTML wrapper tags from a list of sibling HTML tags.
      *
-     * @param htmlString Clipboard content without any OS specific tags.
+     * @param htmlString Clipboard content without any OS-specific tags.
      */
     private _removeFirstLevelWrapperTagsAndBrs;
     /**
-     * Determines if string contains any HTML tags.
+     * Determines if a string contains any HTML tags.
      */
     private _containsAnyRemainingHtmlTags;
     /**

package/src/pastefrommarkdownexperimental.js

@@ -63,12 +63,12 @@ export default class PasteFromMarkdownExperimental extends Plugin {
         });
     }
     /**
-     * Determines if code copied from a website in `text/html` type can be parsed as markdown.
-     * It removes any OS specific HTML tags e.g. <meta> on Mac OS and <!--StartFragment--> on Windows.
+     * Determines if the code copied from a website in the `text/html` type can be parsed as Markdown.
+     * It removes any OS-specific HTML tags, for example, <meta> on macOS and <!--StartFragment--> on Windows.
      * Then removes a single wrapper HTML tag or wrappers for sibling tags, and if there are no more tags left,
-     * returns the remaining text. Returns null, if there are any remaining HTML tags detected.
+     * returns the remaining text. Returns null if there are any remaining HTML tags detected.
      *
-     * @param htmlString Clipboard content in `text/html` type format.
+     * @param htmlString Clipboard content in the `text/html` type format.
      */
     _parseMarkdownFromHtml(htmlString) {
         const withoutOsSpecificTags = this._removeOsSpecificTags(htmlString);
@@ -82,23 +82,23 @@ export default class PasteFromMarkdownExperimental extends Plugin {
         return this._replaceHtmlReservedEntitiesWithCharacters(withoutWrapperTag);
     }
     /**
-     * Removes OS specific tags.
+     * Removes OS-specific tags.
      *
-     * @param htmlString Clipboard content in `text/html` type format.
+     * @param htmlString Clipboard content in the `text/html` type format.
      */
     _removeOsSpecificTags(htmlString) {
-        // Removing <meta> tag present on Mac.
+        // Removing the <meta> tag present on Mac.
         const withoutMetaTag = htmlString.replace(/^<meta\b[^>]*>/, '').trim();
-        // Removing <html> tag present on Windows.
+        // Removing the <html> tag present on Windows.
         const withoutHtmlTag = withoutMetaTag.replace(/^<html>/, '').replace(/<\/html>$/, '').trim();
-        // Removing <body> tag present on Windows.
+        // Removing the <body> tag present on Windows.
         const withoutBodyTag = withoutHtmlTag.replace(/^<body>/, '').replace(/<\/body>$/, '').trim();
-        // Removing <!--StartFragment--> tag present on Windows.
+        // Removing the <!--StartFragment--> tag present on Windows.
         return withoutBodyTag.replace(/^<!--StartFragment-->/, '').replace(/<!--EndFragment-->$/, '').trim();
     }
     /**
-     * If the input HTML string contains any first level formatting tags
-     * like <b>, <strong> or <i>, then we should not treat it as markdown.
+     * If the input HTML string contains any first-level formatting tags
+     * like <b>, <strong>, or <i>, we should not treat it as Markdown.
      *
      * @param htmlString Clipboard content.
      */
@@ -111,7 +111,7 @@ export default class PasteFromMarkdownExperimental extends Plugin {
     /**
      * Removes multiple HTML wrapper tags from a list of sibling HTML tags.
      *
-     * @param htmlString Clipboard content without any OS specific tags.
+     * @param htmlString Clipboard content without any OS-specific tags.
      */
     _removeFirstLevelWrapperTagsAndBrs(htmlString) {
         const parser = new DOMParser();
@@ -128,7 +128,7 @@ export default class PasteFromMarkdownExperimental extends Plugin {
         return tempElement.innerHTML;
     }
     /**
-     * Determines if string contains any HTML tags.
+     * Determines if a string contains any HTML tags.
      */
     _containsAnyRemainingHtmlTags(str) {
         return str.includes('<');