Skip to content

Commit

Permalink
Merge pull request #12 from chrispelzer/master
Browse files Browse the repository at this point in the history
Add more documentation on how to change CKEditor instances
  • Loading branch information
chrispelzer authored Jan 14, 2019
2 parents 4ce2604 + a9497ef commit e28bda6
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ php artisan vendor:publish --tag=config --provider=Waynestate\\Nova\\CKEditorFie

## Customization

### Configuration options
You can change the [configuration options](https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR_config.html) of the CKEditor instance by either editing the published config file at `nova.ckeditor-field.options`

```php
Expand Down Expand Up @@ -99,6 +100,11 @@ public function fields(Request $request)
}
```

### Custom CKEditor Instance
If you wish to not use the CKEditor from the CKEditor CDN, you can change the `ckeditor_url` under `config/nova/ckeditor-field.php` to point to the URL of the CKEditor you wish to use.

If you wish to go the route of a Custom CKEditor Instance using Composer then follow the steps at [Using Composer for Custom CKEditor Instance](https://github.com/waynestate/nova-ckeditor4-field/wiki/Using-Composer-for-Custom-CKEditor-Instance)

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
Expand Down
16 changes: 14 additions & 2 deletions config/ckeditor-field.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,26 @@
|--------------------------------------------------------------------------------
|
| This is the URL used to load the CKEditor instance.
| ex: https://cdn.ckeditor.com/4.10.1/standard-all/ckeditor.js
| ex: https://cdn.ckeditor.com/4.11.2/full-all/ckeditor.js
|
| Note: The URL must begin with "http://" or "https://"
|
| If you wish to use a different CKEditor 4 preset you can use a
| CKEditor 4 preset from https://cdn.ckeditor.com/
|
| or
|
| you could use use composer to install your CKEditor from
| https://github.com/ckeditor/ckeditor-releases/ and symbolic link the
| "vendor/ckeditor/ckeditor" to "public/js/ckeditor".
| then replace the "ckeditor_url" to be
|
| 'ckeditor_url' => config('app.url').'/js/ckeditor/ckeditor.js',
|
| CKEditor 4 is only supported. This will not work with CKEditor 5
|
*/
'ckeditor_url' => 'https://cdn.ckeditor.com/4.10.1/standard-all/ckeditor.js',
'ckeditor_url' => 'https://cdn.ckeditor.com/4.11.2/full-all/ckeditor.js',

/*
|--------------------------------------------------------------------------------
Expand Down

0 comments on commit e28bda6

Please sign in to comment.