https://github.com/grayhatdevelopers/react-page-markdown-plugin
Markdown Plugin for ReactPage Editor. Render markdown right in the browser!
https://github.com/grayhatdevelopers/react-page-markdown-plugin
Last synced: about 1 year ago
JSON representation
Markdown Plugin for ReactPage Editor. Render markdown right in the browser!
- Host: GitHub
- URL: https://github.com/grayhatdevelopers/react-page-markdown-plugin
- Owner: grayhatdevelopers
- License: mit
- Created: 2022-08-19T05:56:52.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-30T17:29:02.000Z (over 3 years ago)
- Last Synced: 2025-02-15T16:42:56.613Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://grayhatdevelopers.github.io/react-page-markdown-plugin/
- Size: 3.32 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# react-page-markdown-plugin
This Markdown plugin allows one to render markdown in a ReactPage component. It uses the [react-markdown library](https://www.npmjs.com/package/react-markdown) to render user-inputted markdown, basic and advanced, on-the-fly.
## What is Markdown, even?
It is a format which allows a user to easily define headings, lists and images etc, right through simple syntax. This README is written in Markdown too!
## Installation
using npm
```js
npm i react-page-markdown-plugin
```
or using yarn
```js
yarn add react-page-markdown-plugin
```
## Instantiation
Define the ```react-page-markdown-plugin``` as part of the cellPlugins list.
```js
import Markdown from 'react-page-markdown-plugin';
const cellPlugins = [
... // Other cell plugins as usual
Markdown
];
```
## Usage Example
```js
import Markdown from 'react-page-markdown-plugin';
import Editor from '@react-page/editor';
const cellPlugins = [Markdown];
export default function SimpleExample() {
const [value, setValue] = useState("");
return (
);
}
```
## Markdown Plugin in Action
---
## React Page Markdown Plugin Demo
A demo for markdown plugin can be found [here](https://grayhatdevelopers.github.io/react-page-markdown-plugin/). Have fun exploring.
## About ReactPage
ReactPage is a smart, extensible and modern editor (“WYSIWYG”) for the web written in React. If you are fed up with the limitations of contenteditable, visit the [official documentation](https://react-page.github.io/docs/#/) of ReactPage.
### ReactPage Demo
A demo can be found on [Demo](https://react-page.github.io/) which reflects the stable release channel on npm.
the current beta version is also available as a demo: [beta Demo](https://react-page.github.io/beta)