milkdown README

The project's README from github.com/Milkdown/milkdown. As one markdown file: README.md.

:baby_bottle:  Milkdown

ci ts download-badge version discord-badge commit license Ask DeepWiki

A plugin-driven WYSIWYG markdown Editor, inspired by Typora, built on top of prosemirror and remark.

The website is designed by Meo and Mirone. Powered by Theme Nord and Material Design.

Documentation

For more information, please check our official documentation website.

What's Next

You can check our Milkdown TODO project page to know what's on the plan.

You can also check milestones to know what's being worked on.

Community

Welcome to join our Discord community.

Contributing

Follow our contribution guide to learn how to contribute to milkdown.

Contributor

contributors

Special thanks to @Meo for her work in design.

Sponsors

If you like this project, please consider fund me to help the maintenance.

Thanks

Thanks to the following projects and companies for their support to milkdown and the open source community.

Vercel OSS Program            

License

MIT

milkdown (Milkdown/milkdown)

Searching Database…

这是什么?Milkdown 是一个基于插件的所见即所得 Markdown 编辑器框架,灵感来自 Typora,构建于 ProseMirror 和 remark 之上。
这是现成的编辑器,还是需要我在其基础上自行搭建的东西?它是一个框架,而不是成品编辑器应用。你可以基于 ProseMirror 和 remark,用插件组装属于自己的编辑器,就像 Typora 将富文本与 Markdown 融合在一起那样。
我该如何在自己的项目中运行它?README 本身没有安装命令,它会引导你前往 Milkdown 官方文档网站,查看安装和使用说明。
它底层究竟基于什么构建?Milkdown 的核心依赖 ProseMirror 作为富文本编辑引擎,并依赖 remark 来解析和序列化 Markdown。
为什么叫 Milkdown?项目使用奶瓶表情符号作为标志,名称是对 “markdown” 的文字游戏,与其受 Typora 启发、友好的所见即所得 Markdown 编辑理念相契合。
有可以提问的社区吗?有的,Milkdown 拥有活跃的 Discord 社区,用户和贡献者在那里讨论项目并互相帮助。
基于插件的架构能带来什么好处?从语法功能到样式,一切都是插件,因此你只需引入所需部分,而不必受限于一刀切的编辑器。
这个项目还在维护吗?在维护。它在 GitHub 上获得了超过 11,900 个 Star,并运行着 CI、CodeQL 和发布工作流,表明项目仍在持续维护。
Creator
Milkdown
Size
107 MB
Stars
12K
Age
5y
Commits · 90 Days