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)

wysiwyg
Searching Database…

What is this?Milkdown is a plugin-driven WYSIWYG markdown editor framework, inspired by Typora, built on top of ProseMirror and remark.
Is this a ready-made editor or something I build on top of?It's a framework rather than a finished editor app - you assemble your own editor from plugins on top of ProseMirror and remark, the same way Typora blends rich text with markdown.
How do I get it running in my project?The README itself has no install commands - you're pointed to the official Milkdown documentation site for setup and usage instructions.
What is it actually built on under the hood?Milkdown's core relies on ProseMirror for the rich-text editing engine and remark for parsing/serializing markdown.
Why is it called Milkdown?The project uses a baby-bottle emoji as its logo and the name plays on 'markdown', fitting its Typora-inspired, friendly WYSIWYG approach to editing markdown.
Is there a community to ask questions in?Yes, Milkdown has an active Discord community where users and contributors discuss the project and get help.
What do I get out of the plugin-driven architecture?Because everything from syntax features to styling is a plugin, you only include what you need instead of being stuck with a one-size-fits-all editor.
Is the project still active?Yes, it has over 11,900 GitHub stars and running CI, CodeQL, and release workflows, indicating ongoing maintenance.
Creator
Milkdown
Size
107 MB
Stars
12K
Age
5y
Commits · 90 Days