Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
@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.
FAQs
GitHub Flavored Markdown data processor for CKEditor 5.
The npm package @ckeditor/ckeditor5-markdown-gfm receives a total of 157,175 weekly downloads. As such, @ckeditor/ckeditor5-markdown-gfm popularity was classified as popular.
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 0 open source maintainers 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
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.