https://github.com/brijeshb42/kattappa

A block based rich text editor.
https://github.com/brijeshb42/kattappa

Last synced: about 1 month ago
JSON representation

A block based rich text editor.

• Host: GitHub
• URL: https://github.com/brijeshb42/kattappa
• Owner: brijeshb42
• License: mit
• Created: 2015-08-10T12:33:48.000Z (over 9 years ago)
• Default Branch: es6
• Last Pushed: 2019-12-16T08:06:42.000Z (about 5 years ago)
• Last Synced: 2024-11-08T12:22:22.828Z (about 2 months ago)
• Language: JavaScript
• Homepage: http://bitwiser.in/kattappa/
• Size: 1.05 MB
• Stars: 106
• Watchers: 9
• Forks: 14
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Current development going on in [scribe](https://github.com/brijeshb42/kattappa/tree/scribe) branch.

>Note: This project is highly under development as it is being integrated into our CMS and the APIs are not consistent and can change at anytime. New features are added (or something is removed) based on the requirements of the CMS.

## Kattappa [demo](http://bitwiser.in/kattappa/)

A block based Rich Text editor.

It uses:

* [ReactJS](http://facebook.github.io/react/) for its UI.

* [medium-editor](https://github.com/yabwe/medium-editor) for rich text editing support.

### Installation

* For `browserify` users:

    * `npm install kattappa`.

    * `var Kattappa = require('kattappa');`

* Or Download the latest release [here](https://github.com/brijeshb42/kattappa/releases/latest).

### Usage

See [usage](https://github.com/brijeshb42/kattappa/blob/es6/src/demo.js);

* Current Blocks:

    - [x] Text

    - [x] Quote

    - [x] Image

    - [x] Horizontal Break

    - [x] Ordered List

    - [x] Unordered List

    - [x] Embeds

        - [x] Instagram

        - [x] Vimeo

        - [x] Youtube

        - [x] Vine

        - [x] Facebook

* Extra features:

    * Blocks can be rearranged.

    * Existing blocks can be deleted.

    * Automatic image upload if `UploadUrl` is provided.

#### Todo

* Add instructions to create custom blocks.

### Made while working @ [http://scroll.in](http://scroll.in)

Currently being used in our internal CMS.