瀏覽代碼

Docs: Package page and README. [skip ci]

Piotrek Koszuliński 8 年之前
父節點
當前提交
48152f43ba
共有 1 個文件被更改,包括 30 次插入0 次删除
  1. 30 0
      packages/ckeditor5-markdown-gfm/docs/api/markdown-gfm.md

+ 30 - 0
packages/ckeditor5-markdown-gfm/docs/api/markdown-gfm.md

@@ -0,0 +1,30 @@
+---
+category: api-reference
+---
+
+# GitHub Flavored Markdown support for CKEditor 5
+
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-markdown-gfm.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-markdown-gfm)
+
+This package implements the GitHub Flavored Markdown data processor for CKEditor 5.
+
+## Documentation
+
+See the {@link features/markdown Markdown output} guide and the {@link module:markdown-gfm/gfmdataprocessor~GFMDataProcessor} documentation.
+
+## Installation
+
+```bash
+npm install --save @ckeditor/ckeditor5-markdown-gfm
+```
+
+## Contribute
+
+The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5-markdown-gfm.
+
+## 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-markdown-gfm)
+* [Issue tracker](https://github.com/ckeditor/ckeditor5-markdown-gfm/issues)
+* [Changelog](https://github.com/ckeditor/ckeditor5-markdown-gfm/blob/master/CHANGELOG.md)