Skip to content

Commit 77bb806

Browse files
committed
add readme file
1 parent 2d87758 commit 77bb806

File tree

2 files changed

+36
-6
lines changed

2 files changed

+36
-6
lines changed

README.md

+36-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,38 @@
11
# ibexa-fieldtype-html-text
22

3-
# TODO
3+
[![Downloads](https://img.shields.io/packagist/dt/netgen/ibexa-fieldtype-html-text.svg)](https://packagist.org/packages/netgen/ibexa-fieldtype-html-text)
4+
[![Latest stable](https://img.shields.io/packagist/v/netgen/ibexa-fieldtype-html-text.svg)](https://packagist.org/packages/netgen/ibexa-fieldtype-html-text)
5+
[![PHP](https://img.shields.io/badge/PHP-%E2%89%A5%208.1-%238892BF.svg)](https://www.php.net)
6+
[![Ibexa](https://img.shields.io/badge/Ibexa-%E2%89%A5%204.0-orange.svg)](https://www.ibexa.co)
7+
8+
Html text field type for Ibexa CMS offers the possibility to render WYSIWYG field both on the frontend and in Ibexa administration.
9+
10+
Installation steps
11+
-----------
12+
### Use Composer
13+
Run composer require:
14+
```
15+
composer require netgen/ibexa-fieldtype-html-text
16+
```
17+
18+
### Activate the bundle
19+
Activate the bundle in `config/bundles.php` file.
20+
21+
```php
22+
<?php
23+
24+
return [
25+
...,
26+
27+
Netgen\IbexaFieldTypeHtmlTextBundle\NetgenIbexaFieldTypeHtmlTextBundle::class => ['all' => true],,
28+
29+
...
30+
];
31+
```
32+
33+
### Include the javascript file on the frontend
34+
Inside the base twig file for your frontend siteaccess, include the built `app.js` file:
35+
```
36+
<script src="{{ asset('bundles/netgenibexafieldtypehtmltext/build/app.js') }}"></script>
37+
```
38+

webpack.config.js

-5
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,6 @@ Encore
2626
config.corejs = 3;
2727
});
2828

29-
//
30-
// Encore.addAliases({
31-
// '@ckeditor': path.resolve('./public/bundles/ibexaadminuiassets/vendors/@ckeditor'),
32-
// });
33-
3429
const nghtmltextApp = Encore.getWebpackConfig();
3530

3631
nghtmltextApp.watchOptions = { poll: true, ignored: /node_modules/ };

0 commit comments

Comments
 (0)