npmpackage.info

react-markdown-editor-lite

a light-weight Markdown editor based on React. 一款轻量的基于React的markdown编辑器

1.3.4

1,052

MIT

TypeScript

13.28 kB

3,123,573 3.2

Installations

npm install react-markdown-editor-lite

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

12.22.12

NPM Version

6.14.16 Score

93.5

Supply Chain

98.5

Quality

78.3

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

6

Total

121

Closed

40

Merged

75

Issues

Open

50

Total

183

Closed

133

Releases

v1.3.3

Updated on Dec 14, 2022

v1.3.2

Updated on Dec 02, 2021

v1.3.1

Updated on Dec 02, 2021

v1.3.0

Updated on Jul 05, 2021

v1.2.4

Updated on Jan 04, 2021

v1.2.2

Updated on Aug 04, 2020

View All 16 releases

Contributors

Unable to fetch Contributors

View All 17 Contributors

Languages

TypeScript

Less

JavaScript

CSS

TypeScript (89.89%)

Less (6.95%)

JavaScript (1.58%)

CSS (1.58%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

HarryChen0506

Download Statistics

Total Downloads

3,123,573

Last Day

4,508

Last Week

30,014

Last Month

119,291

Last Year

1,150,302

GitHub Statistics

MIT License

1,052 Stars

503 Commits

159 Forks

17 Watchers

6 Branches

17 Contributors

Updated on Feb 12, 2025

Bundle Size

51.61 kB

Minified

13.28 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.3.4

Package Id

react-markdown-editor-lite@1.3.4

Unpacked Size

970.52 kB

Size

240.07 kB

File Count

212

NPM Version

6.14.16

Node Version

12.22.12

Total Downloads

Cumulative downloads

Total Downloads

3,123,573

Last Day

-12.9%

4,508

Compared to previous day

Last Week

10.6%

30,014

Compared to previous week

Last Month

36.4%

119,291

Compared to previous month

Last Year

64.4%

1,150,302

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

react-markdown-editor-lite

中文说明

A light-weight(20KB zipped) Markdown editor of React component
Supports TypeScript
Supports custom markdown parser
Full markdown support
Supports pluggable function bars
Full control over UI
Supports image uploading and dragging
Supports synced scrolling between editor and preview
一款轻量的基于 React 的 Markdown 编辑器, 压缩后代码只有 20KB
支持 TypeScript
支持自定义 Markdown 解析器
支持常用的 Markdown 编辑功能，如加粗，斜体等等...
支持插件化的功能键
界面可配置, 如只显示编辑区或预览区
支持图片上传或拖拽
支持编辑区和预览区同步滚动

Demo

Online demo
https://harrychen0506.github.io/react-markdown-editor-lite/

Default configuration

Pluggable bars

Install

1npm install react-markdown-editor-lite --save
2# or
3yarn add react-markdown-editor-lite

Basic usage

Following steps:

Import react-markdown-editor-lite
Register plugins if required
Initialize a markdown parser, such as markdown-it
Start usage

1// import react, react-markdown-editor-lite, and a markdown parser you like
2import React from 'react';
3import * as ReactDOM from 'react-dom';
4import MarkdownIt from 'markdown-it';
5import MdEditor from 'react-markdown-editor-lite';
6// import style manually
7import 'react-markdown-editor-lite/lib/index.css';
8
9// Register plugins if required
10// MdEditor.use(YOUR_PLUGINS_HERE);
11
12// Initialize a markdown parser
13const mdParser = new MarkdownIt(/* Markdown-it options */);
14
15// Finish!
16function handleEditorChange({ html, text }) {
17  console.log('handleEditorChange', html, text);
18}
19export default props => {
20  return (
21    <MdEditor style={{ height: '500px' }} renderHTML={text => mdParser.render(text)} onChange={handleEditorChange} />
22  );
23};

Props and configurations see here
APIs see here
Plugins developer see here
Full demo see src/demo/index.tsx

Usage in server-side render

If you are using a server-side render framework, like Next.js, Gatsby, please use client-side render for this editor.

For example, Next.js has next/dynamic, Gatsby has loadable-components

Following is a example for Next.js:

1import dynamic from 'next/dynamic';
2import 'react-markdown-editor-lite/lib/index.css';
3
4const MdEditor = dynamic(() => import('react-markdown-editor-lite'), {
5  ssr: false,
6});
7
8export default function() {
9  return <MdEditor style={{ height: '500px' }} renderHTML={/* Render function */} />;
10}

With plugins:

1import dynamic from 'next/dynamic';
2import 'react-markdown-editor-lite/lib/index.css';
3
4const MdEditor = dynamic(
5  () => {
6    return new Promise(resolve => {
7      Promise.all([
8        import('react-markdown-editor-lite'),
9        import('./my-plugin'),
10        /** Add more plugins, and use below */
11      ]).then(res => {
12        res[0].default.use(res[1].default);
13        resolve(res[0].default);
14      });
15    });
16  },
17  {
18    ssr: false,
19  },
20);
21
22export default function() {
23  return <MdEditor style={{ height: '500px' }} renderHTML={/* Render function */} />;
24}

Full example see here

Import in Browser

Since 1.1.0, You can add script and link tags in your browser and use the global variable ReactMarkdownEditorLite.

You can download these files directly from

Note: you should import react before ReactMarkdownEditorLite.

For example, in webpack, you import ReactMarkdownEditorLite by script tag in your page, and write webpack config like this:

1externals: {
2  react: 'React',
3  'react-markdown-editor-lite': 'ReactMarkdownEditorLite'
4}

More demos

Authors

ShuangYa github/sylingd
HarryChen0506 github/HarryChen0506

License

MIT

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

7

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/HarryChen0506/react-markdown-editor-lite/main.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/HarryChen0506/react-markdown-editor-lite/main.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/HarryChen0506/react-markdown-editor-lite/main.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/HarryChen0506/react-markdown-editor-lite/main.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/HarryChen0506/react-markdown-editor-lite/main.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/HarryChen0506/react-markdown-editor-lite/publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/HarryChen0506/react-markdown-editor-lite/publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/HarryChen0506/react-markdown-editor-lite/publish.yml/master?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/main.yml:29
Warn: npmCommand not pinned by hash: .github/workflows/publish.yml:26
Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 2 npmCommand dependencies pinned

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

90 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p
Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-6vfc-qv3f-vr6c
Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-r8f7-9pfq-mjmv
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-gj77-59wh-66hg
Warn: Project is vulnerable to: GHSA-hqhp-5p83-hx96
Warn: Project is vulnerable to: GHSA-3949-f494-cm99
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-5q6m-3h65-w53x
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-7mwh-4pqv-wmr8
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-qxg5-2qff-p49r
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-w5p7-h5w8-2hfq
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-qgmg-gppg-76g5
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

3.2

/10

Last Scanned on 2025-02-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to react-markdown-editor-lite

@erda-ui/react-markdown-editor-lite

1.4.9

a light-weight Markdown editor based on React

react-markdown-editor-lite-underline

1.2.10

a light-weight Markdown editor based on React

react-markdown-editor-lite-plus

1.1.0

a light-weight Markdown editor based on React

react-markdown-editor-lite-fork

1.3.3

Custom fork of react-markdown-editor-lite

react-markdown-editor-lite

Installations

Developer Guide

No

CommonJS

12.22.12

6.14.16

Score

Pull Requests

6

121

40

75

Issues

50

183

133

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

51.61 kB

13.28 kB

Maintainers

Package Meta Information

Total Downloads

3,123,573

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

react-markdown-editor-lite

Demo

Install

Basic usage

Usage in server-side render

Import in Browser

More demos

Authors

License

10

10

10

7

0

0

0

0

0

0

0

0

0

3.2

/10

Other packages similar to react-markdown-editor-lite