You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

79 lines
4.8 KiB

3 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
  1. # CKEditor 4 [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Check%20out%20CKEditor%204%20on%20npm&url=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Fckeditor4)
  2. [![GitHub tag](https://img.shields.io/github/tag/ckeditor/ckeditor4-releases.svg)](https://github.com/ckeditor/ckeditor4-releases)
  3. [![Dependencies](https://img.shields.io/david/ckeditor/ckeditor4.svg)](https://david-dm.org/ckeditor/ckeditor4)
  4. [![Dev dependencies](https://img.shields.io/david/dev/ckeditor/ckeditor4.svg)](https://david-dm.org/ckeditor/ckeditor4?type=dev)
  5. [![Join newsletter](https://img.shields.io/badge/join-newsletter-00cc99.svg)](http://eepurl.com/c3zRPr)
  6. [![Follow twitter](https://img.shields.io/badge/follow-twitter-00cc99.svg)](https://twitter.com/ckeditor)
  7. A highly configurable WYSIWYG HTML editor with hundreds of features, from creating rich text content with captioned images, videos, tables, or media embeds to pasting from Word and drag&drop image upload.
  8. Supports a broad range of browsers, including legacy ones.
  9. ![CKEditor 4 screenshot](https://c.cksource.com/a/1/img/npm/ckeditor4.png)
  10. ## Getting Started
  11. ```
  12. npm install --save ckeditor4
  13. ```
  14. Use it on your website:
  15. ```html
  16. <div id="editor">
  17. <p>This is the editor content.</p>
  18. </div>
  19. <script src="./node_modules/ckeditor4/ckeditor.js"></script>
  20. <script>
  21. CKEDITOR.replace( 'editor' );
  22. </script>
  23. ```
  24. You can also load CKEditor 4 using [CDN](https://cdn.ckeditor.com/#ckeditor4).
  25. ## Features
  26. * Over 500 plugins in the [Add-ons Repository](https://ckeditor.com/cke4/addons).
  27. * Pasting from Microsoft Word and Excel.
  28. * Drag&drop image uploads.
  29. * Media embeds to insert videos, tweets, maps, slideshows.
  30. * Powerful clipboard integration.
  31. * Content quality control with Advanced Content Filter.
  32. * Extensible widget system.
  33. * Custom table selection.
  34. * Accessibility conforming to WCAG and Section 508.
  35. * Over 60 localizations available with full RTL support.
  36. ## Presets
  37. The CKEditor 4 npm package comes in the `standard-all` preset, so it includes all official CKEditor plugins, with those from the [standard package](https://sdk.ckeditor.com/samples/standardpreset.html) active by default.
  38. ## Further Resources
  39. * [CKEditor 4 demo](https://ckeditor.com/ckeditor-4/)
  40. * [Documentation](https://ckeditor.com/docs/ckeditor4/latest/)
  41. * [API documentation](https://ckeditor.com/docs/ckeditor4/latest/api/index.html)
  42. * [Configuration reference](https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR_config.html)
  43. * [CKEditor SDK with more samples](https://sdk.ckeditor.com/)
  44. If you are looking for CKEditor 5, here's a link to the relevant npm package: <https://www.npmjs.com/package/ckeditor5>
  45. ## Browser Support
  46. | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome (Android) | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari-ios/safari-ios_48x48.png" alt="iOS Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>iOS Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Opera |
  47. | --------- | --------- | --------- | --------- | --------- | --------- | --------- |
  48. | IE8, IE9, IE10, IE11, Edge| latest version| latest version| latest version| latest version| latest version| latest version
  49. Find out more in the [Browser Compatibility guide](https://ckeditor.com/docs/ckeditor4/latest/guide/dev_browsers.html#officially-supported-browsers).
  50. ## Contribute
  51. If you would like to help maintain the project, follow the [Contribution instructions](https://github.com/ckeditor/ckeditor4/blob/master/.github/CONTRIBUTING.md).
  52. ## License
  53. Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  54. For licensing, see LICENSE.md or <https://ckeditor.com/legal/ckeditor-oss-license>