Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/dasch-swiss/ckeditor_custom_build

Custom Build of CKEditor 5 generated with the online build tool.

https://github.com/dasch-swiss/ckeditor_custom_build

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Custom Build of CKEditor 5 generated with the online build tool.

Basic Info
  • Host: GitHub
  • Owner: dasch-swiss
  • License: other
  • Language: JavaScript
  • Default Branch: main
  • Homepage:
  • Size: 5.98 MB
Statistics
  • Stars: 0
  • Watchers: 8
  • Forks: 1
  • Open Issues: 0
  • Releases: 3
Created almost 6 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog License

README.md

CKEditor 5 editor generated with the online builder

This repository presents a CKEditor 5 editor build generated by the Online builder tool

Quick start

  1. Open the sample/index.html page in the browser.

If you picked the real-time collaboration plugins:

  1. Fill the dialog with correct token, websocket and upload URL endpoints. If you do not have these yet or do not know their meaning, contact us.

  2. Copy the URL and share it or paste in another tab to enjoy real-time collaborative editing.

If you picked the non-real-time collaboration plugins:

  1. Fill the prompt with the license key. If you do not have the license key yet contact us.

Configuring build

Changes like changing toolbar items, changing order of icons or customizing plugin configurations should be relatively easy to make. Open the sample/index.html file and edit the script that initialized the CKEditor 5. Save the file and refresh the browser. That's all.

Note: If you have any problems with browser caching use the Ctrl + R or Cmd + R shortcut depending on your system.

However if you want to remove or add a plugin to the build you need to follow the next step of this guide.

Note that it is also possible to go back to the Online builder tool and pick other set of plugins. But we encourage you to try the harder way and to learn the principles of Node.js and CKEditor 5 ecosystems that will allow you to do more cool things in the future!

Installation

In order to rebuild the application you need to install all dependencies first. To do it, open the terminal in the project directory and type:

shell npm install

Make sure that you have the node and npm installed first. If not, then follow the instructions on the Node.js documentation page.

Adding or removing plugins

Now you can install additional plugin in the build. Just follow the Adding a plugin to an editor tutorial

Rebuilding editor

If you have already done the Installation and Adding or removing plugins steps, you're ready to rebuild the editor by running the following command:

shell npm run build

This will build the CKEditor 5 to the build directory. You can open your browser and you should be able to see the changes you've made in the code. If not, then try to refresh also the browser cache by typing Ctrl + R or Cmd + R depending on your system.

Plugins

The following plugins are implemented: - Footnote: Allow the creation of <footnote content="MY_CONTENT">[Footnote]</footnote> tags in the editor.

What's next?

Follow the guides available on https://ckeditor.com/docs/ckeditor5/latest/framework/index.html and enjoy the document editing.

FAQ

| Where is the place to report bugs and feature requests?

You can create an issue on https://github.com/ckeditor/ckeditor5/issues including the build id - 3m2h62t55rm-qe3sl09wzfmh. Make sure that the question / problem is unique, please look for a possibly asked questions in the search box. Duplicates will be closed.

| Where can I learn more about the CKEditor 5 framework?

Here: https://ckeditor.com/docs/ckeditor5/latest/framework/

| Is it possible to use online builder with common frameworks like React, Vue or Angular?

Not yet, but it these integrations will be available at some point in the future.

Owner

  • Name: DaSCH - Swiss National Data and Service Center for the Humanities
  • Login: dasch-swiss
  • Kind: organization
  • Email: info@dasch.swiss
  • Location: Switzerland

Development repositories of the DaSCH.

GitHub Events

Total
  • Delete event: 4
  • Push event: 14
  • Pull request review event: 1
  • Pull request review comment event: 1
  • Pull request event: 12
  • Create event: 13
Last Year
  • Delete event: 4
  • Push event: 14
  • Pull request review event: 1
  • Pull request review comment event: 1
  • Pull request event: 12
  • Create event: 13

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • derschnee68 (5)
  • irmastnt (1)
Top Labels
Issue Labels
Pull Request Labels