十年匠心定制 · 商业建站与技术教学双线并行 咨询热线:400-886-1026 service@lmnt.cn
ARTICLE DETAIL

资讯详情

深耕网站建设与运营推广的一线实战洞察。

5分钟集成Milkdown:从零跑通插件驱动的Markdown编辑器

5分钟集成Milkdown:从零跑通插件驱动的Markdown编辑器 5分钟集成Milkdown从零跑通插件驱动的Markdown编辑器【免费下载链接】milkdown Plugin driven WYSIWYG markdown editor framework.项目地址: https://gitcode.com/GitHub_Trending/mi/milkdownMilkdown 是一个插件驱动的所见即所得 Markdown 编辑器框架。它的驱动二字很具体编辑器核心自身几乎不带功能标题、列表、图片上传、代码高亮等能力全部是按需装载的独立插件。对需要 Markdown 编辑器的产品页——笔记、后台内容管理、文档站——意味着只装用得到的功能不用为用不上的模块付体积。它解决的是什么问题WYSIWYG 编辑器大多把内容转成 HTML想拿回 Markdown 原文要再做一次转换格式经常走样纯文本编辑器则把输入和预览拆成两块体验割裂。Milkdown 底层基于 ProseMirrorMarkdown 语法被解析进文档模型输入层本身就带着语法标记——打字时所见即所得内容却始终是可还原的 markdown 源文本。仓库里的 e2e/src/ 给了几类场景的可运行页面纯 commonmark、GFM 扩展语法、多编辑器共存、流式输出可以先看效果再决定怎么接。环境自检与安装依赖Node.js 14.0.0 以上npm 或 yarn 任选没有其他硬性依赖。下面这段命令完成建项目、初始化、安装核心套件milkdown/kit聚合了 core、preset 与常用插件的再导出mkdir milkdown-demo cd milkdown-demo npm init -y npm install milkdown/kit再按框架装绑定包React 项目执行npm install milkdown/reactVue 项目执行npm install milkdown/vue。两个包暴露同一套 API——MilkdownProvider提供上下文、Milkdown是挂载点、useEditor负责配置编辑器。三分钟跑通第一个示例不依赖框架时直接用核心 API 即可。这段代码把编辑器挂到#app容器并启用 commonmark 语法保存后配合任意静态服务器就能跑import { Editor, rootCtx } from milkdown/kit/core import { commonmark } from milkdown/kit/preset/commonmark Editor.make() .config((ctx) ctx.set(rootCtx, document.getElementById(app)!)) .use(commonmark) .create()React 项目里同一个编辑器只需声明式三行import { Milkdown, MilkdownProvider, useEditor } from milkdown/react import { commonmark } from milkdown/kit/preset/commonmark function App() { useEditor((root) root.config(commonmark)) return ( MilkdownProvider Milkdown / /MilkdownProvider ) }Vue 侧写法几乎一致装milkdown/vue后把组件与useEditor的导入源换掉配置逻辑原样复用。想加默认内容或监听 markdown 变化useEditor回调里链式调用.config、.use即可e2e 示例目录里每个场景都有现成接线可抄。按需加装图片上传与代码高亮commonmark 预设只覆盖基础语法其余能力按插件逐个加。使用频率最高的两个图片上传upload让用户把图片拖进编辑器后自动变成 markdown 图片节点。接自己的上传服务时更新uploadConfig.key注入 uploaderimport { upload, uploadConfig } from milkdown/kit/plugin/upload Editor.make() .config((ctx) ctx.update(uploadConfig.key, (prev) ({ ...prev, uploader: async (files, schema) { // 把文件发往自己的服务端返回对应的 markdown 文本 }, }))) .use(upload) .create()代码高亮highlightnpm install milkdown/plugin-highlight后use(highlight)代码块即获得语法着色。斜杠命令、协同编辑、流式渲染也走同一套插件管线目录里有什么、能装什么packages/plugins/ 即完整清单。读源码与继续深入的路径仓库是 pnpm monorepo分工边界清晰packages/core/核心Editor 工厂、插件管线、文档模型排查问题时从这入手packages/integrations/react/与packages/integrations/vue/两个框架绑定的实现看use-editor就懂 hook 怎么桥接编辑器生命周期packages/crepe/更上层的一体封装把工具栏、链接提示、拖拽块编辑等预配成开箱形态类型级 API 文档在 docs/api/逐包生成接口签名以它为准。最短的学习路径是照着 e2e 目录抄每个子目录一个可独立运行的页面从preset-commonmark的纯净版起步再往crepe的完整版演进插件管线怎么配置一目了然。【免费下载链接】milkdown Plugin driven WYSIWYG markdown editor framework.项目地址: https://gitcode.com/GitHub_Trending/mi/milkdown创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表