Skip to content

简介

PurrMD 是一个 CodeMirror6 的所见即所得 Markdown 编辑插件,此项目专注于 Markdown 编辑插件部分,而非完整的编辑器

✨ 核心特性

  • 所见即所得编辑 - 即时预览 Markdown 渲染效果
  • GFM 兼容 - 支持 GitHub Flavored Markdown
  • 快捷键支持 - 快捷键提高编辑效率
  • 斜线菜单 - 快速插入 Markdown 语法元素

📋 功能支持

✨ 基础功能

功能语法示例
标题# 一级标题 ~ ###### 六级标题
粗体**粗体**
斜体*斜体*
删除线~~删除线~~
高亮==高亮==
行内代码`行内代码`
链接[text](url)
图片![alt](src)
无序列表- 无序列表
有序列表1. 无序列表
无序任务列表- [ ] 无序任务列表
有序任务列表1. [ ] 有序任务列表
块引用> 块引用
水平分割线---
代码块```javascript
console.log("Hello PurrMD");
```

⌨️ 快捷键

PurrMD 提供以下快捷键来提高编辑效率:

Ctrl+B - 加粗

Ctrl+I - 斜体

Ctrl+D - 删除线

Ctrl+H - 高亮

🔧 斜线菜单

在编辑器中输入 / 字符可以触发斜线菜单,快速插入各种 Markdown 语法元素

🙏 致谢

特别感谢这些优秀项目带来的灵感:

  • HyperMD - 开创性的 WYSIWYG Markdown 编辑体验
  • ProseMark - CodeMirror6 的 Markdown 实现参考
  • CodeMirror6 - 强大的编辑器内核

如果没有以上项目,那么就不会有PurrMD

❓ 常见问题

Q:CodeMirror6 已经有了 ProseMark 为什么还会有这个项目?

A:此编辑器实现的初衷是为我个人的笔记软件 LonaNote 提供 MarkDown 编辑支持,自己实现编辑器功能扩展与定制会更容易一些。

Q:是否支持 Vue/React?

A:CodeMirror 编辑器与框架无关,可以轻松集成到任何前端框架

📝 许可证

MIT license