You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

@ckeditor/ckeditor5-markdown-gfm

Package Overview
Dependencies
4
Maintainers
0
Versions
534
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@ckeditor/ckeditor5-markdown-gfm

GitHub Flavored Markdown data processor for CKEditor 5.


Version published
Maintainers
0
Created

Package description

What is @ckeditor/ckeditor5-markdown-gfm?

@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.

What are @ckeditor/ckeditor5-markdown-gfm's main functionalities?

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);
    });

Other packages similar to @ckeditor/ckeditor5-markdown-gfm

Readme

Source

GitHub Flavored Markdown support for CKEditor 5

npm version Coverage Status Build Status

This package implements the GitHub Flavored Markdown data processor for CKEditor 5.

Demo

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.

Documentation

See the @ckeditor/ckeditor5-markdown-gfm package page as well as the Markdown output and Paste Markdown in CKEditor 5 documentation.

Installation

npm install ckeditor5

License

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.

Keywords

FAQs

Package last updated on 25 Jun 2024

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc