@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.
This plugin is part of the ckeditor5 package. Install the whole package to use it.
npm install ckeditor5
If you want to check full CKEditor 5 capabilities, sign up for a free non-commitment 14-day trial.
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.
Licensed under a dual-license model, this software is available under:
For more information, see: https://ckeditor.com/legal/ckeditor-licensing-options.
44.2.1 (February 20, 2025)
We are happy to announce the release of CKEditor 5 v44.2.1.
During a recent internal audit, we identified a cross-site scripting (XSS) vulnerability in the CKEditor 5 real-time collaboration package (CVE-2025-25299). This vulnerability can lead to unauthorized JavaScript code execution and affects user markers, which represent users' positions within the document.
This vulnerability affects only installations with real-time collaborative editing enabled.
You can read more details in the relevant security advisory and contact us if you have more questions.
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.
Security News
Newly introduced telemetry in devenv 1.4 sparked a backlash over privacy concerns, leading to the removal of its AI-powered feature after strong community pushback.
Security News
TC39 met in Seattle and advanced 9 JavaScript proposals, including three to Stage 4, introducing new features and enhancements for a future ECMAScript release.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.