@texttree/notepad-rcl

Notepad Component Library

This component library allows you to create a Notepad with flexible text editing options.

View Demo · Report Bug · Request Feature

Key features:

• It is a block-styled editor based on Editor.js

• There is an autosave in browser

• Storing multiple notes

  
  

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Purpose

• Convenient and compact note editor
• Note storage
• Note sharing
  

Problem

• The developer has a need to implement a convenient note-taking tool in his application
• While reading, studying Scripture, or translating, it is often necessary to take notes. You have to use third party apps.
  

Built With

• React
• Editor.js
• localforage

Getting Started

Installation

1. Install the package:

yarn add @texttree/notepad-rcl

or

npm install @texttree/notepad-rcl

2. Import Redactor in app:

import { Redactor } from '@texttree/notepad-rcl';

<Redactor />;

For more examples, please refer to the Styleguidist link

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. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

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

Contact

TextTree - Discord

Project Link: https://github.com/texttree/notepad-rcl