https://github.com/Z-Editor/Z-Editor
Online Z-notations Editor with Prosemirror and React.js
https://github.com/Z-Editor/Z-Editor
formal methods prosemirror reactjs z-notations
Last synced: about 2 months ago
JSON representation
Online Z-notations Editor with Prosemirror and React.js
- Host: GitHub
- URL: https://github.com/Z-Editor/Z-Editor
- Owner: Z-Editor
- License: mit
- Created: 2017-08-04T17:23:36.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-10T13:53:17.000Z (4 months ago)
- Last Synced: 2025-03-10T14:39:07.156Z (4 months ago)
- Topics: formal, methods, prosemirror, reactjs, z-notations
- Language: TypeScript
- Homepage: https://z-editor.github.io/
- Size: 1.2 MB
- Stars: 147
- Watchers: 6
- Forks: 43
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
- awesome-draft-js - Z-Editor - Online Z-notations editor. (Standalone Editors Built on Draft.js)
README
# Z-Editor
A tool to create, edit and print formal [Z-notation](https://en.wikipedia.org/wiki/Z_notation) documents.
Try out the **[Demo](https://z-editor.github.io/)**.
## Table of Contents
- [Features](#features)
- [Getting started](#getting-started)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Build](#build)
- [Start](#start)
- [Contributing](#contributing)
- [Future plans](#future-plans)
- [License](#license)
## Features
* Z-Editor supports following notations in the toolbar,
- Schemas
- Logics
- Sets
- Relations
- Functions
- Sequences
- Bags
* Download Z-Editor work as a PDF or a `z` file.
* Import a `z` file to the editor and continue work.
* Iconic schemas were created using [Prosemirror](https://prosemirror.net/) blocks.
* Rich Text Utilities.
## Getting started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
- git
- yarn
### Install
```
git clone https://github.com/Z-Editor/Z-Editor.git
cd Z-Editor
yarn install
```
### Build
```
yarn run build
```
### Start
```
yarn run dev
```
## Contributing
- We would greatly appreciate any [contribution](CONTRIBUTING.md) you make.
- If you have ideas for more functionality or recipes that should be on this project, [let us know](https://github.com/Z-Editor/Z-Editor/issues).
## Future plans
- Add page breaker lines.
- Improve unit tests.
## License
Z-Editor is under the MIT license. See the [License](LICENSE) for more information.