# GitHub Flavored Markdown support for CKEditor 5

This package implements the GitHub Flavored Markdown data processor for CKEditor 5. It also includes the experimental paste Markdown feature that allows the users to paste Markdown-formatted content straight into the editor.

<a id="demo">

## Demo

Check out the [demo in the Markdown output feature guide](../features/markdown.md#demo) to see the editor configured to input and output Markdown code. Use the [demo in the paste Markdown feature guide](../features/pasting/paste-markdown.md#demo) to try out experimental pasting Markdown-formatted content straight into the editor.

<a id="documentation">

## Documentation

See the [Markdown output guide](../features/markdown.md) and the [`MarkdownGfmDataProcessor`](module_markdown-gfm_gfmdataprocessor-MarkdownGfmDataProcessor.md) documentation. Read the [Paste Markdown feature guide](../features/pasting/paste-markdown.md) and the [`PasteFromMarkdownExperimental`](module_markdown-gfm_pastefrommarkdownexperimental-PasteFromMarkdownExperimental.md) documentation.

<a id="installation">

## Installation

This package is part of our open-source aggregate package.

```bash
npm install ckeditor5
```

<a id="contribute">

## Contribute

The source code of this package is available on GitHub at <https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-markdown-gfm>.

<a id="external-links">

## External links

* [`@ckeditor/ckeditor5-markdown-gfm` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-markdown-gfm)
* [`ckeditor/ckeditor5-markdown-gfm` on GitHub](https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-markdown-gfm)
* [Issue tracker](https://github.com/ckeditor/ckeditor5/issues)
* [Changelog](https://github.com/ckeditor/ckeditor5/blob/master/CHANGELOG.md)

---

Full index of the CKEditor 5 API reference: [llms.txt](llms.txt)