https://github.com/Doist/typist

The mighty Tiptap-based rich-text editor that powers Doist products.
https://github.com/Doist/typist

doist editor markdown markdown-editor plain-text plain-text-editor prosemirror react reactjs rich-text rich-text-editor text-editor tiptap tiptap-editor typescript typist wysiwyg wysiwyg-editor

Last synced: about 2 months ago
JSON representation

The mighty Tiptap-based rich-text editor that powers Doist products.

• Host: GitHub
• URL: https://github.com/Doist/typist
• Owner: Doist
• License: mit
• Created: 2022-11-01T18:19:42.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-15T00:08:34.000Z (5 months ago)
• Last Synced: 2024-04-15T02:00:17.583Z (5 months ago)
• Topics: doist, editor, markdown, markdown-editor, plain-text, plain-text-editor, prosemirror, react, reactjs, rich-text, rich-text-editor, text-editor, tiptap, tiptap-editor, typescript, typist, wysiwyg, wysiwyg-editor
• Language: TypeScript
• Homepage: https://typist.doist.dev
• Size: 27.7 MB
• Stars: 371
• Watchers: 8
• Forks: 11
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


    


        

            

            

        

    



Typist is the mighty [Tiptap](https://tiptap.dev/)-based rich-text editor React component that powers Doist products, which can also be used for displaying content in a read-only fashion. Typist also supports a plain-text mode, and comes with HTML/Markdown serializers.

> **Note**

>

> This project is not attempting to be an all-purpose rich-text editor. Whilst everyone is welcome to fork or use this package in their own products, development decisions are centered around Doist product requirements.



[![GitHub: CI Validation](https://github.com/Doist/typist/actions/workflows/check-ci-validation.yml/badge.svg?branch=main)](https://github.com/Doist/typist/actions/workflows/check-ci-validation.yml?query=branch%3Amain)

[![npm Version](https://img.shields.io/npm/v/@doist/typist)](https://www.npmjs.com/package/@doist/typist)

[![npm Bundle Size (minified)](https://img.shields.io/bundlephobia/min/@doist/typist)](https://bundlephobia.com/package/@doist/typist)

[![npm Downloads (monthly)](https://img.shields.io/npm/dm/@doist/typist?color=blue)](https://npmtrends.com/@doist/typist)

[![semantic-release: Conventional Commits](https://img.shields.io/badge/semantic--release-Conventional%20Commits-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)

[![License: MIT](https://img.shields.io/github/license/doist/typist)](LICENSE.md)



## Installation

```sh

npm install --save @doist/typist

```

### Peer Dependencies

If you are using **npm 7+** and the `legacy-peer-deps` options is not enabled, peer dependencies should have been automatically installed for you with the command above. Otherwise, you can install them with:

```sh

npm info @doist/typist peerDependencies --json \

    | command sed 's/[\{\},]//g ; s/: /@/g' \

    | xargs npm install --save

```

## Usage

```tsx

import { TypistEditor, RichTextKit } from '@doist/typist'

function TypistEditorContainer({ content }) {

    return (

        

    )

}

```

If you're looking for additional documentation, in-depth examples, or a live demo, please check out our [Storybook](https://typist.doist.dev/).

## Resources

A curated list of open-source rich-text editors powered by Tiptap that we can draw inspiration from:

-   GitLab's content editor:\

    https://gitlab.com/gitlab-org/gitlab/-/tree/master/app/assets/javascripts/content_editor

## Contributing

If you're interested in contributing code and/or documentation, please read our [contributing guide](CONTRIBUTING.md).

## License

The use of this source code is governed by an MIT-style license that can be found in the [LICENSE](LICENSE) file.