52

0

Milkdown

插件驱动的所见即所得的Markdown编辑器框架

开始使用

概览

Milkdown 是一个轻量但强大的 WYSIWYG(所见即所得)的 markdown 编辑器。它有两部分组成:

  • • 一个小巧的核心,提供了插件加载器和一些内置插件。
  • • 大量的插件,包括语法、命令和组件。

通过这种模式,你可以根据喜好开启或关闭语法和功能,例如表格,数学公式或斜线指令。你甚至可以创造自己的插件来实现你的想法。

🍼 有趣的事实:Milkdown 的文档就是由 Milkdown 渲染的。


特性

  • [ ] 📝 所见即所得的 Markdown - 以一种优雅的方式编写 markdown
  • [ ] 🎨 可定制主题 - 主题可以通过 npm 包安装和共享
  • [ ] 🎮 可交互 - 通过插件支持你的脑洞
  • [ ] 🦾 值得信赖 - 基于 prosemirrorremark 构建
  • [ ] ⚡ 斜线指令和工具条 - 让任何人都可以使用,通过插件
  • [ ] 🧮 数学支持 - LaTeX 数学公式支持,通过插件
  • [ ] 📊 表格支持 - 拥有流畅的 ui 的表格支持,通过插件
  • [ ] 🍻 协同编辑 - 基于 yjs 的协同编辑支持,通过插件
  • [ ] 💾 剪贴板 - 支持 markdown 格式的复制粘贴,通过插件
  • [ ] 👍 Emoji - 支持 emoji 快捷指令和选择器,通过插件

技术栈

Milkdown 基于这些工具:

  • Prosemirror 和它的社区 - 一个用于在 web 端构建富文本编辑器的工具包
  • Remark 和它的社区 - 正确的 markdown 解析器
  • TypeScript - 以 TypeScript 编写
  • Emotion - 用于构建样式的强大的 css in js 工具
  • Prism - 代码块支持
  • Katex - 高性能的渲染数学公式