ckeditor5-svelte
Advanced tools
Comparing version
{ | ||
"name": "ckeditor5-svelte", | ||
"version": "0.0.8", | ||
"description": "Svelte3 component for CKEditor5 – the best browser-based rich text editor.", | ||
"version": "0.0.9", | ||
"description": "Svelte3 component for CKEditor5", | ||
"homepage": "https://github.com/techlab23/ckeditor5-svelte", | ||
@@ -6,0 +6,0 @@ "author": "Shirish Nigam <nigamshirish@gmail.com>", |
@@ -1,5 +0,8 @@ | ||
# CKEditor 5 rich text editor component for Svelte.js 3 | ||
## CKEditor5 editor component for Svelte 3 | ||
## How to install package | ||
This component is a thin wrapper around ckeditor5 document editor. | ||
Below are the set of instructions to create svelte project, install component and a basic setup with CKEditor DocumentEditor build. | ||
### How to install package | ||
```bash | ||
@@ -9,9 +12,9 @@ $ npm i ckeditor5-svelte | ||
## Getting started | ||
### Getting started | ||
### Create a new svelte project and install dependencies | ||
#### Create a new svelte project and install dependencies | ||
```bash | ||
npx degit sveltejs/template my-svelte-project | ||
# or download and extract | ||
# or download and extract | ||
cd my-svelte-project | ||
@@ -24,3 +27,3 @@ # to use Typescript run: | ||
### Install ckeditor5-svelte package | ||
#### Install ckeditor5-svelte package | ||
@@ -30,4 +33,5 @@ ```bash | ||
``` | ||
### Install DocumentEditor build of ckeditor | ||
#### Install DocumentEditor build of ckeditor | ||
```bash | ||
@@ -37,3 +41,3 @@ npm i @ckeditor/ckeditor5-build-decoupled-document | ||
### Update App.svelte in your project with the following | ||
#### Update App.svelte in your project with the following | ||
@@ -54,3 +58,3 @@ ```js | ||
// Uncomment the custom editor config if you need to customise the editor. | ||
// Note: If you don't pass toolbar object then Document editor will use default set of toolbar items. | ||
// Note: If you don't pass toolbar object then Document editor will use default set of toolbar items. | ||
let editorConfig = { | ||
@@ -96,12 +100,6 @@ toolbar: { | ||
### Run your project | ||
#### Run your project | ||
```bash | ||
npm run dev | ||
npm run dev | ||
``` | ||
31771
0.45%100
-1.96%