Update README
This commit is contained in:
parent
945e851a9f
commit
f54546259b
34
README.md
34
README.md
|
@ -1,34 +1,8 @@
|
|||
# schlechtenburg
|
||||
# Schlechtenburg
|
||||
|
||||
## Project setup
|
||||
```
|
||||
npm install
|
||||
```
|
||||
Experimental WYSIWYG editor framework made with Vue 3 and TypeScript. It takes cues from both Wordpress' Gutenberg editor and CKEditor, though it tries to become a best of both worlds; a very lightweight, easily extensible core, written with modern components and the accompanying state management.
|
||||
|
||||
### Compiles and hot-reloads for development
|
||||
```
|
||||
npm run serve
|
||||
```
|
||||
It inputs and outputs a tree of JSON-serializable data.
|
||||
|
||||
### Compiles and minifies for production
|
||||
```
|
||||
npm run build
|
||||
```
|
||||
Just a plaything for now.
|
||||
|
||||
### Run your unit tests
|
||||
```
|
||||
npm run test:unit
|
||||
```
|
||||
|
||||
### Run your end-to-end tests
|
||||
```
|
||||
npm run test:e2e
|
||||
```
|
||||
|
||||
### Lints and fixes files
|
||||
```
|
||||
npm run lint
|
||||
```
|
||||
|
||||
### Customize configuration
|
||||
See [Configuration Reference](https://cli.vuejs.org/config/).
|
||||
|
|
|
@ -18,7 +18,9 @@ export default defineComponent({
|
|||
<div id="app">
|
||||
<select
|
||||
value={activeTab.value}
|
||||
onChange={($event: Event) => { activeTab.value = ($event.target as HTMLSelectElement).value; }}
|
||||
onChange={($event: Event) => {
|
||||
activeTab.value = ($event.target as HTMLSelectElement).value;
|
||||
}}
|
||||
>
|
||||
<option>edit</option>
|
||||
<option>display</option>
|
||||
|
@ -43,7 +45,7 @@ export default defineComponent({
|
|||
mode="display"
|
||||
/>;
|
||||
case 'data':
|
||||
return <pre><code>{JSON.stringify(block, null, 2)}</code></pre>;
|
||||
return <pre><code>{ JSON.stringify(block, null, 2) }</code></pre>;
|
||||
}
|
||||
})()}
|
||||
</div>
|
||||
|
|
|
@ -51,7 +51,7 @@ export default defineComponent({
|
|||
},
|
||||
},
|
||||
|
||||
setup(props) {
|
||||
setup(props: SchlechtenburgProps) {
|
||||
const el: Ref<null|HTMLElement> = ref(null);
|
||||
useResizeObserver(el, EditorDimensions);
|
||||
|
||||
|
|
Loading…
Reference in a new issue