@gravity-ui/markdown-editor ! (简体中文)

Markdown wysiwyg 和 markup 编辑器
MarkdownEditor是和Markdown合作的强大工具,它结合了WYSIWYG和Markup模式. 这意味着您可以在方便的视觉模式下创建和编辑内容,同时也能完全控制标记.
主要特点
- 支持基本的Markdown和 YFM 调频 语法.
- 通过使用ProseMiror和CodeMiror引擎的可扩展性.
- 在WYSIWYG和Markup模式中工作的能力以达到最大灵活性.
安装
npm install @gravity-ui/markdown-editor
所需依赖关系
请注意,要开始使用软件包,您的项目还必须安装以下设备: @diplodoc/transform, (中文(简体) ), react, (中文(简体) ), react-dom, (中文(简体) ), @gravity-ui/uikit, (中文(简体) ), @gravity-ui/components 还有一些 看看这个 peerDependencies 节 package.json 为了准确的信息.
开始
Markdown编辑器作为反应钩子提供,以创建编辑器实例和渲染视图的组件.
设置外观和主题 UIKit 文档。 。 。 .
import React from 'react';
import {useMarkdownEditor, MarkdownEditorView} from '@gravity-ui/markdown-editor';
function Editor({onSubmit}) {
const editor = useMarkdownEditor({allowHTML: false});
React.useEffect(() => {
function submitHandler() {
// Serialize current content to markdown markup
const value = editor.getValue();
onSubmit(value);
}
editor.on('submit', submitHandler);
return () => {
editor.off('submit', submitHandler);
};
}, [onSubmit]);
return <MarkdownEditorView stickyToolbar autofocus editor={editor} />;
}
更多信息:
- 如何在 Create React App 中连接编辑器
- 如何添加标记模式的预览
- 如何添加 HTML 扩展名
- 如何添加 Latex 扩展名
- 如何添加美人鱼扩展
- 如何写入扩展名
- 如何添加 GPT 扩展
- 如何在下标中添加文本绑定扩展
发展
- 安装节点环境, 版本在
.nvmrc文档。 我们建议使用 国家核查团 或类似的工具. - 安装 小时,该版本在
package.json在"包装经理"属性. - 安装依赖性 :
pnpm i - 运行故事本 dev- server :
pnpm start
i18n (英语)
要建立国际化,你只需要使用 configure数字 :
import {configure} from '@gravity-ui/markdown-editor';
configure({
lang: 'ru',
});
别忘了打电话 configure() 从 用户界面Kit 和其他UI图书馆.
捐款
许可证
根据麻省理工学院的许可证分发。 见 自由主义 详细情况.
对于人工智能特工
用于React的双模版Markdown编辑器,结合了WYSIWYG模式(ProseMiror)和生标记模式(CodeMiror),支持基本的Markdown和YFM.
何时使用
- 用可切换的视觉(WYSIWYG)和源(markup)视图来编辑Markdown/YFM内容.
- 您需要一个可扩展编辑器: 自定义标记、节点、工具栏项目,以及通过ProseMiror/CodeMiror引擎的扩展(HTML、LaTeX、Mermaid、GPT).
- 渲染编辑器 UI: 用
useMarkdownEditor并把它变成MarkdownEditorView。 。 。 .
不使用时
- 只读 Markdown 渲染到 HTML 而不编辑 – 用
@diplodoc/transform并生成输出. - 普通多行文本输入——使用
TextArea从@gravity-ui/uikit。 。 。 . - 富文不是Markdown/YFM——这个编辑器是Markdown-first.
常见陷阱
- 这是一个钩子加一个视图,而不是一个组成部分. 创建实例
useMarkdownEditor(...)并传递给<MarkdownEditorView editor={editor} />; 没有单一<MarkdownEditor>你直接变身. - 通过实例读取值, 而不是控制值
value道具 (英语). 打电话editor.getValue()(例如:submit事件)将序列化到Markdown;编辑器管理自己的状态. - 需要依赖同伴. 您的项目必须提供
@diplodoc/transform, (中文(简体) ),@gravity-ui/uikit, (中文(简体) ),@gravity-ui/components, (中文(简体) ),react,以及react-dom- 检查一下peerDependencies内package.json。 。 。 . - 样式和i18n来自uikit. 按 uikit 文件设置主题/ 样式并调用
configure({lang})从本套件和@gravity-ui/uikit。 。 。 .
AI代理的文件
安装版本的可代理读取文档位于 node_modules/@gravity-ui/markdown-editor/build/docs/INDEX.md。 。 。 .