diff --git a/src/core/base/README.md b/src/core/base/README.md index abc565df..d8b156e4 100644 --- a/src/core/base/README.md +++ b/src/core/base/README.md @@ -2,7 +2,8 @@ # UIPPlugin -**UIPPlugin** - base class for all UIP elements. Extending it allows creating custom UIP components. +**UIPPlugin** - base class for all UIP elements. +Should be used as a parent class for all custom plugins of UIP to correctly observe and change UIPModel state. ## Description diff --git a/src/core/preview/README.md b/src/core/preview/README.md index 9f3a3f99..06d4fb42 100644 --- a/src/core/preview/README.md +++ b/src/core/preview/README.md @@ -1,9 +1,11 @@ # UIP Preview -**UIPPreview** - custom element, that displays active markup. Extends [UIPPlugin](src/core/README.md#uip-plugin). +**UIPPreview** - is a mandatory UIP custom element that displays active markup. Extends [UIPPlugin](src/core/README.md#uip-plugin). **UIPPreview** element observes [UIPStateModel](src/core/README.md#uip-state-model) changes, but it doesn't produce them. +The `uip-preview` should be placed inside [UIPRoot](src/core/README.md#uip-root) element. + ## Example ```html diff --git a/src/plugins/editor/README.md b/src/plugins/editor/README.md index 282b2ccd..b0ad9d26 100644 --- a/src/plugins/editor/README.md +++ b/src/plugins/editor/README.md @@ -1,7 +1,16 @@ # UIP Editor -**UIPEditor** - custom element, code editor for changing current markup. It allows user to manually configure -the component inside [UIPPreview](src/core/README.md). Extends [UIPPlugin](src/core/README.md#uip-plugin). +**UIPEditor** - UIP module to provide live-editor for current playground content. +Extends [UIPPlugin](src/core/README.md#uip-plugin). ## Description -**UIPEditor** is based on [Codejar](https://medv.io/codejar/) editor. We also use [Prism.js](https://prismjs.com/) for highlighting. +**UIPEditor** is based on [Codejar](https://medv.io/codejar/) editor. +Use [Prism.js](https://prismjs.com/) for code highlighting by default. + +## Example +```html + + + + +```