uw-editor v0.1.28

About The Project

Purpose

• Create a re-usable editor component that can be integrated into application to support editing scripture text in USFM format.

Scope

• Mostly this is a wrapper for the XELAH text editor. uW editor is mostly responsible for the UI, toolbar, etc and XELAH supplies the text editor.

Built With

• React.js

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation/First Steps

If you wish to use this editor in your app you will need to add it as a dependency with:

npm install uw-editor

OR

yarn add uw-editor

Also you will need to add the peer dependencies:

npm install @mui/material @mui/styles @mui/icons-material  @mui/styled-engine npm:@mui/styled-engine-sc@latest react react-dom translation-helps-rcl

OR

yarn add @mui/material @mui/styles @mui/icons-material  @mui/styled-engine npm:@mui/styled-engine-sc@latest react react-dom translation-helps-rcl

Usage/Integration

See Styleguidist link for many usage examples.

Roadmap

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. Guidelines for external contributions.

You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

If you would like to fork the repo and create a pull request.

1. Fork the Project
2. Clone the repo

   git clone https://github.com/unfoldingWord/uw-editor.git

3. Install NPM packages

   yarn

4. Create your Feature Branch (git checkout -b feature/AmazingFeature)

5. Commit your Changes (git commit -m 'Add some AmazingFeature')
6. Push to the Branch (git push origin feature/AmazingFeature)
7. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.