Editor

Small editor webxdc application with export-markdown support.

This app uses yjs and prosemirror, along with the y-webxdc provider to offer collaborative editing for webxdc-supporting messengers. While this editor app can be productively used, it focuses on small code size and complexity, and does not aim to become a full-fledged editor. Little improvement PRs are welcome!

NOTE: this repository is in maintenance mode. New features can typically only arrive if a merge/pull request is done. Bugs may be reported.

Trying the latest release

1. Download the latest editor.xdc from release assets.

2. Send a message into a group chat and attach the downloaded editor.xdc release file.

3. Anyone in the chat can now hit the "start" button and edit the chat-shared document.

Development

Install

npm install

Run

Run the app in the webxdc-dev tool:

npm start

Test

Run code-style checks with the following command (basically same as npm run check):

npm test

Build

To create a .xdc file that can be send to a chat in any Webxdc-capable app, execute:

npm run build

The resulting .xdc file is saved in the dist-release/ folder. Then just send the file with a message to a chat and you are ready to go!

To build with Eruda debugger, run ERUDA=1 npm run build.

Code Style

Code style is checked and fixed by eslint, run:

npm run check
npm run fix

to perform checks or apply suggested fixes. Note that npm test will automatically check code style.

Release

With Forgejo Actions

1. Simply push a tag.

Given that the Actions are properly set up, the workflow will run and publish a release. You can later edit the release.

Manually

1. Follow Building

2. Go to https://codeberg.org/webxdc/editor/releases/new

3. Upload the .xdc file from dist-release/. Make sure that the name of the file is the same as in the previous releases.

4. Fill and submit the form.