# :baby_bottle:  Milkdown

[![ci][ci-badge]][ci-link]
![ts][ts-badge]
[![download-badge]][download-link]
![version][version-badge]
[![discord-badge]][discord-link]
![commit][commit-badge]
![license][license-badge]
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Milkdown/milkdown)

<div align="center">
  <img src="/assets/logo.svg" />
</div>

A plugin-driven WYSIWYG markdown Editor, inspired by [Typora](https://typora.io/),
built on top of [prosemirror](https://prosemirror.net/) and [remark](https://github.com/remarkjs/remark).

The website is designed by [Meo](https://meo.cool/) and [Mirone](https://github.com/Saul-Mirone).
Powered by [Theme Nord](https://www.nordtheme.com/) and [Material Design](https://material.io/design).

# Documentation

For more information, please check our [official documentation website](https://milkdown.dev/).

# What's Next

You can check our [Milkdown TODO](https://github.com/orgs/Milkdown/projects/1) project page to know what's on the plan.

You can also check [milestones](https://github.com/Milkdown/milkdown/milestones) to know what's being worked on.

# Community

Welcome to join our [Discord community][discord-link].

# Contributing

Follow our [contribution guide](https://github.com/Milkdown/milkdown/blob/main/CONTRIBUTING.md) to learn how to contribute to milkdown.

# Contributor

<a href="https://github.com/Milkdown/milkdown/graphs/contributors">
  <img src="https://opencollective.com/milkdown/contributors.svg?width=890&button=false" alt="contributors">
</a>

Special thanks to [@Meo](https://meo.cool/) for her work in design.

# Sponsors

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

<a href="https://github.com/sponsors/Saul-Mirone">
  <img src="/../../../../Saul-Mirone/Saul-Mirone/blob/main/sponsors.svg">
</a>

# Thanks

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

<a href="https://jb.gg/OpenSource">
  <img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg" height="50" />
</a>

<a href="https://vercel.com/oss">
  <img alt="Vercel OSS Program" src="https://vercel.com/oss/program-badge.svg" height="50" />
</a>
&nbsp;&nbsp;
<a href="https://www.cypress.io/">
  <img src="/assets/cypress.svg" height="50" />
</a>
&nbsp;&nbsp;
<a href="https://nx.dev/">
  <img src="/assets/nx.svg" height="50" />
</a>
&nbsp;&nbsp;
<a href="https://www.algolia.com/">
  <img src="/assets/algolia.svg" height="50" />
</a>
&nbsp;&nbsp;
<a href="https://vercel.com/milkdown?utm_source=milkdown&utm_campaign=oss">
  <img src="/assets/vercel.svg" height="50" />
</a>

# License

[MIT](/LICENSE)

[ci-badge]: https://github.com/Milkdown/milkdown/actions/workflows/ci.yml/badge.svg
[ci-link]: https://github.com/Milkdown/milkdown/actions/workflows/ci.yml
[ts-badge]: https://badgen.net/badge/-/TypeScript/blue?icon=typescript&label
[download-badge]: https://img.shields.io/npm/dm/@milkdown/core
[download-link]: https://www.npmjs.com/search?q=%40milkdown
[version-badge]: https://img.shields.io/npm/v/@milkdown/core
[commit-badge]: https://img.shields.io/github/commit-activity/m/Milkdown/milkdown
[license-badge]: https://img.shields.io/github/license/Milkdown/milkdown
[discord-badge]: https://img.shields.io/discord/870181036041060352
[discord-link]: https://discord.gg/SdMnrSMyBX
[vercel-oss-badge]: https://vercel.com/oss/program-badge.svg