Code Monkey home page Code Monkey logo

ckeditor-custom-build's Introduction

OL CKEditor5 Custom Build

This is our custom build for CKEditor5. It's forked from their 'classic' build (here).

Development setup

Install the deps with yarn install. Then if you want to check out the editor you can do npm start and visit localhost:8080 to see a development build of the editor with an example document. There's both an editable and a read-only example.

Remember to npm run fmt and npm run lint!

Building and publishing

You can run npm run build to run the webpack build. If you want to test the integration with another project, like open-discussions, you can do the following:

In this repo:

npm run build
rm -rf *.tgz
npm pack

This will create a .tgz just like what would be pushed to the npm registry, but without publishing anything. We can use this in other projects to try out installing the package without having to push a new version up to npm.

To use it, copy the .tgz file to your local clone of the open-discussions (or other project) repo and run:

docker-compose run watch yarn add ./name-of-the-file.tgz

This will add the .tgz file in such a way that looks, to node, like a normal npm package has been installed from the registry. You can then go ahead to include the code in OD and try it out.

ckeditor-custom-build's People

Contributors

alicewriteswrongs avatar annatomanek avatar jodator avatar ma2ciek avatar oleq avatar onurozkan avatar pomek avatar reinmar avatar szymonkups avatar wwalc avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

ckeditor-custom-build's Issues

basic custom build

basic features to get us started:

  • ability to pass in an object to represent document state, get an object in the same format out
  • rehydrate the editor with an existing, saved document and edit it further
  • display existing documents in a read-only mode

get tests running on this repo

Running into a lot of issues getting some basic tests to run. Turns out that all the ckeditor packages are developed together in a monorepo type setup, with Lernu and mgit used to coordinate things. They use the same test tooling everywhere: https://github.com/ckeditor/ckeditor5-dev

I tried to get this repo working in the overall monorepo setup (following the guide here: https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/development-environment.html) to see if I could get the tests included with the repo to run in the default setup, but no dice.

I also tried using mocha to run that file, but also ran into issues with compatibility between babel-register and the versions of babel required by different ckeditor dependencies.

I think what I'm going to try now is maybe just either writing the tests without ES6 syntax (which will maybe play more nicely) or look into the monorepo thing more. I want to have the tests just live in here without dependencies on the larger CKEditor ecosystem though, so I'm leaning more towards something that permits me to do that.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.