https://github.com/danielbrodin/react-marky-markdown

Markdown editor component for react
https://github.com/danielbrodin/react-marky-markdown

Last synced: 5 months ago
JSON representation

Markdown editor component for react

• Host: GitHub
• URL: https://github.com/danielbrodin/react-marky-markdown
• Owner: danielbrodin
• License: mit
• Created: 2019-10-24T14:32:02.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T23:25:12.000Z (over 3 years ago)
• Last Synced: 2025-10-06T14:21:49.806Z (9 months ago)
• Language: TypeScript
• Homepage: https://codesandbox.io/s/react-marky-markdown-78vd4
• Size: 1.09 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# React Marky Markdown

[![npm version](https://badge.fury.io/js/react-marky-markdown.svg)](https://badge.fury.io/js/react-marky-markdown) 

![](https://github.com/danielbrodin/react-marky-markdown/workflows/Test/badge.svg)

A clean markdown editor for react.

Currently in beta. Like this readme :)

## Usage

`yarn add react-marky-markdown`

```js

import { Editor, Mention } from 'react-marky-markdown';

// Includes necessary styling

import 'react-marky-markdown/dist/styles.css';

const App = () => {

  return (

    

      

    

  );

};

```

## Props

```ts

// Editor

{

  defaultValue?: string;

  singleLine?: boolean;

  disableFormatting?: boolean;

  onChange?(value: string): void;

  onSubmit?(): void;

  onBlur?(): void;

  onCancel?(): void;

}

// Mention

{

  prefix: string;

  data: Item[]; // { value: string | number; label: string; }

  onSearch?(value: string): void;

}

```