Skip to content
Snippets Groups Projects
README.md 832 B
Newer Older
Christos's avatar
Christos committed
<div width="100%" align="center">
  <h1>Wax Editor</h1>
</div>
Christos's avatar
Christos committed

Christos's avatar
Christos committed
| [![MIT license](https://img.shields.io/badge/license-MIT-e51879.svg)](https://gitlab.coko.foundation/wax/wax-prosemirror/raw/master/LICENSE) |
| :------------------------------------------------------------------------------------------------------------------------------------------: |
Christos's avatar
Christos committed

Christos's avatar
Christos committed

Christos's avatar
Christos committed
Wax Editor is built on top of the Prosemirror library. Check Prosemirror [website](https://prosemirror.net/) and [GitHub repo](https://github.com/ProseMirror) for more information.
Christos's avatar
Christos committed

Yannis Barlas's avatar
Yannis Barlas committed
## [Various Demos.](https://demo.waxjs.net/)
Christos's avatar
Christos committed

Christos's avatar
Christos committed

Christos's avatar
Christos committed
## Get up and running

Christos's avatar
Christos committed
Run a local version of the demos
Christos's avatar
Christos committed

Christos's avatar
Christos committed
1.  `yarn with node >= 14`
Christos's avatar
Christos committed

Christos's avatar
Christos committed
2.  `yarn build`

3.  `yarn start` Will bring up a demos of different ediitors
Christos's avatar
Christos committed

Christos's avatar
Christos committed
## Documentation
Christos's avatar
Christos committed
Documentation can be found [here](https://waxjs.net/docs/wax/).