https://github.com/joaocnh/react-headless-markdown-editor
A React component for simple, customisable markdown editors.
https://github.com/joaocnh/react-headless-markdown-editor
component headless markdown markdown-editor markdown-editor-react react
Last synced: 11 months ago
JSON representation
A React component for simple, customisable markdown editors.
- Host: GitHub
- URL: https://github.com/joaocnh/react-headless-markdown-editor
- Owner: JoaoCnh
- License: mit
- Created: 2022-11-16T21:53:19.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-19T19:05:36.000Z (over 3 years ago)
- Last Synced: 2025-03-10T11:47:34.697Z (about 1 year ago)
- Topics: component, headless, markdown, markdown-editor, markdown-editor-react, react
- Language: TypeScript
- Homepage: https://joaocnh.github.io/react-headless-markdown-editor/
- Size: 61.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# react-headless-markdown-editor
## 👋 Intro
A React component for simple, customizable markdown editors.
This library lets you:
- Customize your editor however you see fit (it's Headless 🙈)
- Create custom controls
- Have a simple editor up & running in a few seconds
## 🚀 How to use
### Install
```bash
npm install -S react-headless-markdown-editor
# or
yarn add react-headless-markdown-editor
# or
pnpm i react-headless-markdown-editor
```
### Usage
With no styling options
```js
import { Editor } from "react-headless-markdown-editor";
;
```
But it's easy enough to add something.
I've made it work beautifully with normal css classes or tailwind.
```js
import { Editor } from "react-headless-markdown-editor";
;
```
Check out the [Demo](https://joaocnh.github.io/react-headless-markdown-editor/) for an example of styling
[Source Code](https://github.com/JoaoCnh/react-headless-markdown-editor/blob/main/src/App.tsx)