@ckeditor/ckeditor5-markdown-gfm
Advanced tools
GitHub Flavored Markdown data processor for CKEditor 5.
@ckeditor/ckeditor5-markdown-gfm is a plugin for CKEditor 5 that allows you to convert the editor's content to GitHub Flavored Markdown (GFM) and vice versa. This package is particularly useful for applications that need to support markdown editing and rendering, providing a seamless way to handle markdown content within a rich text editor.
Markdown to HTML Conversion
This feature allows you to initialize CKEditor with the Markdown plugin, enabling the conversion of markdown content to HTML within the editor.
const ClassicEditor = require('@ckeditor/ckeditor5-build-classic');
const Markdown = require('@ckeditor/ckeditor5-markdown-gfm/src/markdown');
ClassicEditor
.create(document.querySelector('#editor'), {
plugins: [Markdown],
toolbar: ['bold', 'italic', 'link']
})
.then(editor => {
console.log('Editor was initialized', editor);
})
.catch(error => {
console.error(error.stack);
});HTML to Markdown Conversion
This feature allows you to convert the HTML content within the CKEditor back to markdown format, making it easy to store or manipulate markdown data.
const ClassicEditor = require('@ckeditor/ckeditor5-build-classic');
const Markdown = require('@ckeditor/ckeditor5-markdown-gfm/src/markdown');
ClassicEditor
.create(document.querySelector('#editor'), {
plugins: [Markdown],
toolbar: ['bold', 'italic', 'link']
})
.then(editor => {
const markdownData = editor.plugins.get('Markdown').getMarkdown();
console.log('Markdown data:', markdownData);
})
.catch(error => {
console.error(error.stack);
});markdown-it is a markdown parser that supports GitHub Flavored Markdown and can be extended with plugins. Unlike @ckeditor/ckeditor5-markdown-gfm, markdown-it is not tied to a specific editor and can be used in various contexts where markdown parsing is needed.
Showdown is a JavaScript markdown to HTML converter, compatible with GitHub Flavored Markdown. It is a standalone library that can be integrated with different editors or used independently, offering more flexibility compared to the CKEditor-specific @ckeditor/ckeditor5-markdown-gfm.
Marked is a fast markdown parser and compiler that supports GitHub Flavored Markdown. It is highly configurable and can be used in various environments, providing a more general-purpose solution compared to the CKEditor-specific @ckeditor/ckeditor5-markdown-gfm.
This package implements the GitHub Flavored Markdown data processor for CKEditor 5.
Check out the demo in the Markdown output feature guide to see the editor configured to input and output Markdown code. Use the demo in the Paste Markdown feature guide to try out experimental pasting Markdown-formatted content straight into the editor.
See the @ckeditor/ckeditor5-markdown-gfm package page as well as the Markdown output and Paste Markdown in CKEditor 5 documentation.
npm install ckeditor5
Licensed under the terms of GNU General Public License Version 2 or later. For full details about the license, please check the LICENSE.md file or https://ckeditor.com/legal/ckeditor-oss-license.
43.1.1 (September 25, 2024)
We are happy to announce the release of CKEditor 5 v43.1.1.
During a recent internal audit, we identified a Cross-Site Scripting (XSS) vulnerability in the CKEditor 5 clipboard package (CVE-2024-45613). This vulnerability could be triggered by a specific user action, leading to unauthorized JavaScript code execution, if the attacker managed to insert malicious content into the editor, which might happen with a very specific editor configuration.
This vulnerability affects only installations where the editor configuration meets the following criteria:
You can read more details in the relevant security advisory and contact us if you have more questions.
Taking the occasion, we decided to introduce additional hardening to some parts of our codebase that introduce theoretical and unexploitable issues. Our security team confirmed that none of these issues were exploitable in a real scenario, however, we decided to fix them, in order to increase the overall security posture of our software.
Check out the Versioning policy guide for more information.
<details> <summary>Released packages (summary)</summary>Other releases:
FAQs
GitHub Flavored Markdown data processor for CKEditor 5.
We found that @ckeditor/ckeditor5-markdown-gfm demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.