Sourc-editor NPM

Sourc

Repo at https://github.com/Th3OneAndOnly/Sourc

Sourc is a text editor for the web, ready to use in your projects. It's lightweight, extensible, and embeddable. This repository is open-source and openly accepts contributions. See the Contributing section for more.

Features (still WIP)

Fully implemented

Basic text input including:
- Single character input
- Single character deleting
- Arrow key movement
Plugin based code injection system.
A powerful, simple to use logging system.

In Progress

The rest of the basic text editing features

This is a synopsis. See CHANGLELOG.md for up to date changes

Installation

Install Sourc with npm

  cd your-project
  npm install --save sourc-editor

Take note that you will need webpack and some sort of dev server environment to run your webpage.

Documentation

Coming soon! 👀

Contributing

Contributions are welcome and appreciated!

Please see contributing.md for rules and regulations about contributing.

To get started, clone this repo:

git clone https://github.com/Th3OneAndOnly/Sourc sourc-dev
cd sourc-dev
npm i

Now you can use npm run dev-ts to make a demo folder containing everything you need to kickstart local development. There's also an dev-js for a javascript demos as well. You can build each by running npm run build-lcl-demo!

To build Sourc, use npm run build 🏗️ and to build the docs use npm run doc 📖.

Now, hack away! 🔨 Thank you so much for making a contribution, please make a pull request in the repo after checking your PR with contributing.md.

Please adhere to this project's code of conduct.