https://github.com/brilliant-js/brilliant

Brilliant is a WYSIWYG markdown editor with live preview support, based on Draft-js and React, implemented in TypeScript. It's compatible with popular browsers.
https://github.com/brilliant-js/brilliant

draft draft-editor draft-js editor editors markdown markdown-editor markdown-previewer react react-editor react-editor-js react-hooks typescript wysiwyg wysiwyg-editor wysiwyg-html-editor

Last synced: about 1 month ago
JSON representation

Brilliant is a WYSIWYG markdown editor with live preview support, based on Draft-js and React, implemented in TypeScript. It's compatible with popular browsers.

• Host: GitHub
• URL: https://github.com/brilliant-js/brilliant
• Owner: brilliant-js
• License: mit
• Created: 2021-02-02T04:29:06.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-02-07T10:11:02.000Z (almost 4 years ago)
• Last Synced: 2024-09-27T03:08:35.369Z (about 2 months ago)
• Topics: draft, draft-editor, draft-js, editor, editors, markdown, markdown-editor, markdown-previewer, react, react-editor, react-editor-js, react-hooks, typescript, wysiwyg, wysiwyg-editor, wysiwyg-html-editor
• Language: TypeScript
• Homepage: https://brilliant-js.com
• Size: 3.48 MB
• Stars: 110
• Watchers: 2
• Forks: 14
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
English | [简体中文](./README.zh-CN.md)

# Brilliant Editor-EN

Brilliant is a WYSIWYG markdown editor with live preview support, based on Draft-js and React, implemented in TypeScript. It's compatible with popular browsers.

- [Online Demo](https://brilliant-js.com)

![usage demo](https://cdn.jsdelivr.net/gh/brilliant-js/brilliant/screenshots/editor.gif)

## Installation

```bash

# Install using yarn

yarn add brilliant-editor

# Install using npm

npm install brilliant-editor --save

```

### Example Usage

```javascript

import React from 'react';

import Brilliant from 'brilliant-editor';

import 'brilliant-editor/dist/index.css';

const App = () => {

  return (

    


      

    

  );

};


export default App;

```

## Browsers support

Modern browsers.

| [](http://godban.github.io/browsers-support-badges/)Edge | [](http://godban.github.io/browsers-support-badges/)Firefox | [](http://godban.github.io/browsers-support-badges/)Chrome | [](http://godban.github.io/browsers-support-badges/)Safari | [](http://godban.github.io/browsers-support-badges/)Opera |

| --------- | --------- | --------- | --------- | --------- | 

|Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions

## Thanks

- [Draftjs-utils](https://github.com/jpuri/draftjs-utils) 

- [react-draft-wysiwyg](https://github.com/jpuri/react-draft-wysiwyg)

- [draft-js-plugins-editor](https://github.com/mediasilo/draft-js-plugins-editor) 

- [draft-js-prism](https://github.com/SamyPesse/draft-js-prism)