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 — это фреймворк для WYSIWYG-редактора markdown на основе плагинов, вдохновлённый Typora, построенный поверх ProseMirror и remark.
Это готовый редактор или то, на основе чего я сам собираю редактор?Это скорее фреймворк, а не готовое приложение-редактор: вы собираете свой редактор из плагинов поверх ProseMirror и remark, примерно так же, как Typora сочетает форматированный текст с markdown.
Как запустить это в моём проекте?В самом README нет команд для установки — там отправляют на официальный сайт документации Milkdown, где есть инструкции по настройке и использованию.
На чём это построено внутри?Ядро Milkdown опирается на ProseMirror как движок редактирования форматированного текста и на remark для разбора и сохранения markdown.
Почему это называется Milkdown?В логотипе проекта используется эмодзи детской бутылочки, а название обыгрывает слово «markdown». Это соответствует дружелюбному WYSIWYG-подходу к редактированию markdown, вдохновлённому Typora.
Есть ли сообщество, где можно задать вопросы?Да, у Milkdown есть активное сообщество в Discord, где пользователи и участники проекта обсуждают его и помогают друг другу.
Что даёт архитектура на основе плагинов?Поскольку всё, от возможностей синтаксиса до стилизации, реализовано как плагины, вы подключаете только то, что нужно, а не остаётесь с универсальным редактором «на все случаи».
Проект ещё развивается?Да, у него более 11 900 звёзд на GitHub, а также работают рабочие процессы CI, CodeQL и релизов, что говорит о постоянной поддержке.
Creator
Milkdown
Size
107 MB
Stars
12K
Age
5y
Commits · 90 Days