mypackage-webbuilder

The ORY Editor is a smart, extensible and modern editor ("WYSIWYG") for the web written in React. If you are fed up with the limitations of contenteditable, you are in the right place.

The ORY Editor is used at Germany's largest (~800k uniques per month) E-Learning Website www.serlo.org to improve the wiki experience.

Check out the demo at ory-editor.aeneas.io!

IMPORTANT: This editor is pre-release and backwards compatibility is not guaranteed. It is maintained as a personal project by its author and core-maintainer Aeneas Rekkas.

• Introduction
  • What's the problem?
  • What makes it different?
• Quickstart
• Documentation
• How to run, develop, and contribute
  • Install dependencies
  • Run the example(s)
  • Run the toolchain
  • Run the documentation
• Known issues

Introduction

I have been part of the Wikipedia for learning for almost a decade now. The experience and the lessons learned made me embark on the journey to build the ORY Editor. I wanted to make content editing on the web easy and enrich the Open Source Community with technology that moves the needle significantly for how content is created and edited on the web.

What's the problem?

I had to realize that existing open source content editing solutions had one of the three flaws:

• The produced markup was horrific, a lot of sanitation had to take place and XSS is always a threat.
• The author must learn special mark up, like markdown, before being able to produce content. These text-based solutions are usually unable to specify a layout and complex data structures like tables are annoying to edit.
• Editors based on contenteditable are unable to work with layouts (e.g. flexbox or floating grids).

So what's different?

I concluded that a solution must meet the following principles:

• The state is a normalized JSON object, no HTML involved.
• It is a visual editor that does not require programming experience or special training.
• Based on reusable React Components, it gives developers, authors and designers new ways of working together and creating better and richer experiences more easily.
• It works on mobile and touch devices.

With these principles in mind, I went out and implemented the ORY Editor, which you are looking at right now.

Quickstart

Currently the focus is on optimizing the ORY Editor for usage with React. Versions that do not require React in the future may be shipped at some point. Please check the ReactJS tutorial!

$ npm install --save ory-editor

Note: The ory-editor package is a metapackage. It includes the core, the default ui and some officially supported plugins. Use this package primarily for convenience.

Documentation

Check out the user guide on gitbook.

How to run, develop, and contribute

Do you want to run, develop or contribute to the ORY Editor? For that you need Node installed on your system. Use git to check out this repository as followed.

$ git clone https://github.com/ory/editor.git
$ cd editor

Install dependencies

The ORY Editor is a monorepo that you initialize with:

$ npm i
$ npm run bootstrap

You can also use yarn.

$ yarn
$ yarn bootstrap

Run the example(s)

Here are some examples that are a good starting point if you want to familiarize yourself with the editor. To run the examples, use one of the following commands:

$ npm run start

Run the toolchain

The tool chain contains tests and tslint. It is highly recommended to run this while developing.

# run the tests in watch mode
$ yarn run test:watch

# run tslint in watch mode
$ yarn run lint:watch

Run the documentation

To run the guide in watch mode, do:

$ yarn run docs:guide

To generate API docs, run:

$ yarn run docs:api

Recommended tools

Feel free to use whatever works for you, these works for us. Especially care about using "prettier" when writing code as it will avoid merge conflicts on code style.

IDE: vscode Vscode extensions: prettier, tslint, code spell checker, beautify css/sass/scss/less

Known issues

Types resolution error

In case you change a lot of files, especially in core or UI, you might end up seeing old versions of these files when working on plugins. To fix this, run

$ npm run build:lib

Which builds the library code. If this doesn't help (and you're in vscode), make sure to reload window (CTRL+SHIFT+P -> Reload Window). That forces vscode to reinitialize typescript declaration files.

Other issues

Known issues are tracked in the issues tab.

Attributions

Thank you Tebriz for contributing the logo!