Skip to content

letterpad/editor-docs

Repository files navigation

Introduction

Build Status

The leterpad editor is an extract from the Letterpad CMS.

This editor gives a high level api of the slate editor along with a flexible plugin architecture. It comes with a bunch of rich plugins for most of your use cases. You can extend any of the plugins or create your own plugins. The letterpad editor has a dynamic markdown editor which renders the preview inline as you type.

Why this editor ?

The idea comes from the Medium editor. I found the medium editor as one of the most minimalistic editor limited by its features and not open source. While developing the Letterpad project which is react CMS for blogs, I wanted to give a similar experience and also make it opensource. The editor worked out so well, that I decided to extract it from Letterpad into its own repository so that others can use it in their own projects.

✨ Features

  • Distraction free inline editing
  • A set of high-quality React components out of the box.
  • Written in TypeScript with predictable static types.
  • Flexible Plugin architecture
  • Styled Components
  • End-to-end test coverage
  • Themes

🤝 Contributing

Read our contributing guide and let's build a better antd together.

We welcome all contributions. Please read our CONTRIBUTING.md first. You can submit any ideas as pull requests or as GitHub issues. If you'd like to improve code, check out the Development Instructions and have a good time! :)

If you are a collaborator, please follow our Pull Request principle to create a Pull Request by collaborator template.

About

Documentation of letterpad editor

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published