friendsofagape / usfm-editor

A React component for WYSIWYG USFM editing.

⚠️ This project is not maintained anymore. Newer development is focused on https://github.com/xelahjs/xelah

usfm-editor

usfm-editor is a WYSIWYG editor component for USFM (Unified Standard Format Markers). It is a JavaScript React component based on the Slate editor framework. It aims to enable rich editing capabilities in new and existing scripture translation applications.

Demo

A demo editor is available, and you can examine its source code in this repo for integration info.

NPM

Builds are published on NPM and can be installed with npm i usfm-editor

Bugs and contributions

If you use the editor, please let us know how we can best support you by filing issues (and pull requests).

To build and test locally, install npm, clone the repo, and run the following in its directory:

npm install
npm install -g npx
npx styleguidist server

Then monitor the live-updated demo at http://localhost:6060/

Roadmap

This is currently a beta release, with several improvements planned .