Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Quadrats/quadrats

A complete rich text editor. Currently based on Slate framework.
https://github.com/Quadrats/quadrats

Last synced: 16 days ago
JSON representation

A complete rich text editor. Currently based on Slate framework.

Host: GitHub
URL: https://github.com/Quadrats/quadrats
Owner: Quadrats
License: mit
Created: 2020-12-04T08:39:53.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2024-08-29T07:51:17.000Z (3 months ago)
Last Synced: 2024-10-20T12:53:22.822Z (24 days ago)
Language: TypeScript
Homepage: https://demo.quadrats.io
Size: 3.38 MB
Stars: 5
Watchers: 4
Forks: 0
Open Issues: 10
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # Quadrats

A complete rich text editor.

Currently based on [Slate](https://github.com/ianstormtaylor/slate) framework.

[![npm package](https://img.shields.io/npm/v/@quadrats/react.svg?maxAge=60)](https://www.npmjs.com/package/@quadrats/react)

[![npm downloads](https://img.shields.io/npm/dt/@quadrats/react.svg?maxAge=60)](https://www.npmjs.com/package/@quadrats/react)

[![Licence](https://img.shields.io/github/license/Quadrats/quadrats.svg?maxAge=60)](https://github.com/Quadrats/quadrats/blob/main/LICENSE)

[Try out our plugins](https://demo.quadrats.io/?path=/story/playground--editor).

## Features

### Blocks

- Titles [h1, h2, h3, h4, h5, h6]

- Blockquote

- List [ol, ul]

- Divider

- Embed [youtube, vimeo, instagram, facebook, twitter, podcastApple, spotify]

- Inline Mark [bold, italic, underline, strikethrough, highlight, customHighlight]

- Footnote

- Link

- Image [file-uploader]

- Read More

### Locales

- zh-TW [Traditional Chinese]

- en-US [American English]

### Themes

- Default

- Dark Mode

## Development scripts

Useful scripts include:

```bash

yarn

```

> Installs package dependencies

```bash

yarn build

```

> Build the local packages.

```bash

yarn storybook:start

```

> Starts storybook dev (after building).

```bash

yarn lint

```

> Lint ts/js files w/ [eslint](https://eslint.org/) and scss files w/ [stylelint](https://stylelint.io/).

```bash

yarn test

```

> Test w/ [jest](https://jestjs.io/).

```bash

yarn release

```

> Using lerna to bump package versions, build and publish to npm via [conventional changelog](https://github.com/conventional-changelog).