简单的 Markdown 编辑器 md-editor

MIT
JavaScript TypeScript
跨平台
2019-08-29
同一种调调

疫情之下,程序员如何转型?共享数字化转型加速度,就在微软在线技术峰会>>>

md-editor 带有预览功能的简单 Markdown 编辑器,使用 React.js 和 TypeScript 实现。 提供具有语法突出显示,自动按需懒加载 prismjs 的 187 种语言高亮的简单 Markdown 编辑器。 这基于 textarea 封装,因此它不依赖于任何现代代码编辑器,如 Acs,CodeMirror,Monaco 等,同时支持工具栏高度定制。

特征

  • 📑 通过按Tab键缩进行或选定的文本,并使用可自定义的缩进。
  • ♻️ 基于 textarea 封装,不依赖于任何现代代码编辑器。
  • 🚧 不依赖 uiw 中的任何组件。
  • 🚘 新行上的自动有序无需列表。
  • 💥支持自动按需懒加载 prismjs 的 187 种语言高亮。
  • 🖥支持编辑和预览滚动条联动效果。
  • 🌎Gitee 实例预览:https://uiw.gitee.io/react-md-editor/
  • 🌎Github 实例预览:https://uiwjs.github.io/react-md-editor/ 
  • 🌎CodeSandbox 实例预览

快速开始

npm i @uiw/react-md-editor

使用

import React from "react";
import ReactDOM from "react-dom";
import MDEditor from '@uiw/react-md-editor';

export default function App() {
  const [value, setValue] = React.useState("**Hello world!!!**");
  return (
    <div className="container">
      <MDEditor
        value={value}
        onChange={setValue}
      />
      <MDEditor.Markdown source={value} />
    </div>
  );
}

 

自定义工具栏

import React from "react";
import ReactDOM from "react-dom";
import MDEditor, { commands } from '@uiw/react-md-editor';

const title3: commands.ICommand = {
  name: 'title3',
  keyCommand: 'title3',
  buttonProps: { 'aria-label': 'Insert title3' },
  icon: (
    <svg width="12" height="12" viewBox="0 0 520 520">
      <path fill="currentColor" d="M15.7083333,468 C7.03242448,468 0,462.030833 0,454.666667 L0,421.333333 C0,413.969167 7.03242448,408 15.7083333,408 L361.291667,408 C369.967576,408 377,413.969167 377,421.333333 L377,454.666667 C377,462.030833 369.967576,468 361.291667,468 L15.7083333,468 Z M21.6666667,366 C9.69989583,366 0,359.831861 0,352.222222 L0,317.777778 C0,310.168139 9.69989583,304 21.6666667,304 L498.333333,304 C510.300104,304 520,310.168139 520,317.777778 L520,352.222222 C520,359.831861 510.300104,366 498.333333,366 L21.6666667,366 Z M136.835938,64 L136.835937,126 L107.25,126 L107.25,251 L40.75,251 L40.75,126 L-5.68434189e-14,126 L-5.68434189e-14,64 L136.835938,64 Z M212,64 L212,251 L161.648438,251 L161.648438,64 L212,64 Z M378,64 L378,126 L343.25,126 L343.25,251 L281.75,251 L281.75,126 L238,126 L238,64 L378,64 Z M449.047619,189.550781 L520,189.550781 L520,251 L405,251 L405,64 L449.047619,64 L449.047619,189.550781 Z" />
    </svg>
  ),
  execute: (state: commands.TextState, api: commands.TextApi) => {
    let modifyText = `### ${state.selectedText}\n`;
    if (!state.selectedText) {
      modifyText = `### `;
    }
    api.replaceSelection(modifyText);
  },
};

export default function App() {
  const [value, setValue] = React.useState("**Hello world!!!**");
  return (
    <div className="container">
      <MDEditor
        value="Hello Markdown!"
        commands={[
          commands.bold, commands.hr, commands.italic, commands.divider, commands.codeEdit, commands.codeLive, commands.codePreview, commands.divider,
          commands.fullscreen, 
          // Custom Toolbars
          title3,
        ]}
      />
    </div>
  );
}

单独预览 Markdown

import React from "react";
import ReactDOM from "react-dom";
import MDEditor from '@uiw/react-md-editor';

export default function App() {
  return (
    <div className="container">
      <MDEditor.Markdown source="Hello Markdown!" />
    </div>
  );
}

支持自定义 KaTeX 预览

KaTeX 是一个快速,易于使用的 JavaScript 库,用于在 Web 上进行 TeX 数学渲染,我们通过 KaTeX执行数学渲染。

以下实例是在 CodeSandbox 中的预览效果

npm install katex
import React from "react";
import ReactDOM from "react-dom";
import MDEditor from '@uiw/react-md-editor';
import katex from 'katex';
import 'katex/dist/katex.css';


const mdKaTeX = `This is to display the 
\`\$\$\c = \\pm\\sqrt{a^2 + b^2}\$\$\`
 in one line

\`\`\`KaTeX
c = \\pm\\sqrt{a^2 + b^2}
\`\`\`
`;

const renderers = {
  inlineCode: ({ children }) => {
    if (/^\$\$(.*)\$\$/.test(children)) {
      const html = katex.renderToString(children.replace(/^\$\$(.*)\$\$/, '$1'), {
        throwOnError: false,
      });
      return <code dangerouslySetInnerHTML={{ __html: html }} />
    }
    return children;
  },
  code: ({ children, language, value }) => {
    if (language.toLocaleLowerCase() === 'katex') {
      const html = katex.renderToString(value, {
        throwOnError: false
      });
      return (
        <pre>
          <code dangerouslySetInnerHTML={{ __html: html }} />
        </pre>
      );
    }
    return children;
  }
}

export default function App() {
  return (
    <MDEditor value={mdKaTeX} previewOptions={{ renderers: renderers }} />
  );
}

 

的码云指数为
超过 的项目
加载中

评论(0)

暂无评论

MDEditor 1.12.0 发布,Markdown 编辑器

MDEditor 是带有预览功能的简单 Markdown 编辑器,使用 React.js 和 TypeScript 实现。 提供具有语法突出显示,自动按需懒加载 prismjs 的 187 种语言高亮的简单 Markdown 编辑器。 这基于 ...

2019/09/05 09:16

MDEditor 1.11.3 发布,基于 textarea 封装的 Markdown 编辑器

MDEditor 带有预览功能的简单 Markdown 编辑器,使用 React.js 和 TypeScript 实现。 提供具有语法突出显示,自动按需懒加载 prismjs 的 187 种语言高亮的简单 Markdown 编辑器。 这基于 te...

2019/08/31 22:59

没有更多内容

加载失败,请刷新页面

没有更多内容

暂无问答

node:md-server

Edit your file with your favourite editor and get the result in the browser when you save the file. [https://www.npmjs.com/package/md-server](https://www.npmjs.com/package/md-se...

2015/12/12 22:38
35
0
asasasassssssssssss

22232收射手打算打算

2016/01/12 00:44
487
1
Idea设置javadoc注释

1. File Header模板 settings>Editor>File and code templates>includes>File Header 这里设置的模板会被类的文档注释等地方引用,所以直接改这里即可。 2. 类注释及Copyright settings>Edit...

2017/10/23 13:52
1.2K
0
如何让在md文档中插入本地图片

1、编辑器可以用一些编辑器,这些编辑器可以把本地图片转化为base64的字符串比如gitbook 1.1、gitbook桌面应用下载地址:https://www.gitbook.com/editor/ 1.2、命令行工具:http://blog.csd...

2016/11/25 22:42
170
0
使用Gitbook写开源书籍,过一把作家瘾

使用Gitbook写开源书籍,过一把作家瘾,使用GitBook Editor 写开源书籍

2016/04/26 22:24
3.8K
4
objective-c 加密 MD5 解密MD5

main.m文件 // main.m // 加密 MD5 #import <Foundation/Foundation.h> #import "NSString+Extend.h" int main(int argc, const char * argv[]) { NSLog(@"%@",[@"123456" md5]); //IOS 以后...

2016/01/25 13:25
245
1
md5对比文件

1、简介   MD5算法常常被用来验证网络文件传输的完整性,防止文件被人篡改。MD5 全称是报文摘要算法(Message-Digest Algorithm 5),此算法对任意长度的信息逐位进行计算,产生一个二进制...

2015/10/22 18:00
633
1
OkHttp离线缓存实现

OkHttp内部已经支持了标准的Http协议缓存策略,如Last-Modified, Etag, Cache-Control等方式,看起来已经是非常够用了,但是我们还想让缓存在这样的场景下得到使用: 当客户端设备网络中断或者...

2016/12/11 23:29
1.9K
0
md5sum校验命令

md5sum校验命令

2015/10/10 10:54
1.3K
0
学习gitbook发布自己的电子书

http://www.tonglei.win/2016/10/18/IT学习/Gitbook/学习gitbook发布自己的电子书/

2016/10/18 14:33
2K
3

没有更多内容

加载失败,请刷新页面

返回顶部
顶部