# Milkdown

**Repository Path**: joliu/Milkdown

## Basic Information

- **Project Name**: Milkdown
- **Description**: 插件驱动的所见即所得的Markdown编辑器框架
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://milkdown.dev
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 12
- **Created**: 2021-10-29
- **Last Updated**: 2021-10-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# <img src="https://raw.githubusercontent.com/Saul-Mirone/milkdown/648e593619e870cc7ddc794bb8768cdf06b0b279/gh-pages/public/milkdown-mini.svg" height="30px" /> 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]

<div align="center">
    <img src="https://raw.githubusercontent.com/Saul-Mirone/milkdown/648e593619e870cc7ddc794bb8768cdf06b0b279/gh-pages/public/milkdown-homepage.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://www.meo.cool/). Powered by [Theme Nord](https://www.nordtheme.com/) and [Material Design](https://material.io/design).

# Documentation

For more information, please check our official documentations:

[English](https://saul-mirone.github.io/milkdown/) | [简体中文](https://saul-mirone.github.io/milkdown/#/zh-hans)

# What's Next

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

# Community

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

# Contributing

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

# Contributor

<a title="Saul Mirone" href="https://github.com/Saul-Mirone"><img src="https://avatars.githubusercontent.com/u/10047788?v=4" width="100" alt="profile picture of Saul Mirone"></a>
<a title="Meo" href="https://github.com/Saul-Meo"><img src="https://avatars.githubusercontent.com/u/14139395?v=4" width="100" alt="profile picture of Meo"></a>
<a title="xia" href="https://github.com/xiadd"><img src="https://avatars.githubusercontent.com/u/8351437?v=4" width="100" alt="profile picture of xiadd"></a>
<a title="EllePeng" href="https://github.com/Ele-Peng"><img src="https://avatars.githubusercontent.com/u/18499385?v=4" width="100" alt="profile picture of EllePeng"></a>
<a title="Songhn" href="https://github.com/songhn233"><img src="https://avatars.githubusercontent.com/u/47357585?v=4" width="100" alt="profile picture of Songhn"></a>
<a title="Emo" href="https://github.com/yobome"><img src="https://avatars.githubusercontent.com/u/26548120?v=4" width="100" alt="profile picture of Emo"></a>
<a title="Matia" href="https://github.com/mattcroat"><img src="https://avatars.githubusercontent.com/u/38083522?v=4" width="100" alt="profile picture of Matia"></a>
<a title="Alex Neises" href="https://github.com/AlexNeises"><img src="https://avatars.githubusercontent.com/u/1816254?v=4" width="100" alt="profile picture of Alex Neises"></a>
<a title="Brett Mandler" href="https://github.com/Brettm12345"><img src="https://avatars.githubusercontent.com/u/7571012?v=4" width="100" alt="profile picture of Brett Mandler"></a>
<a title="Hidekazu Kubota" href="https://github.com/sosuisen"><img src="https://avatars.githubusercontent.com/u/13513812?v=4" width="100" alt="profile picture of Hidekazu Kubota"></a>

# Sponsors

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

<a title="Johno Scott" href="https://github.com/johnoscott"><img src="https://avatars.githubusercontent.com/u/291958?v=4" width="100" alt="profile picture of Johno Scott"></a>
<a title="Inkyu Oh" href="https://github.com/gomjellie"><img src="https://avatars.githubusercontent.com/u/13645032?v=4" width="100" alt="profile picture of Inkyu Oh"></a>

# License

[MIT](/LICENSE)

[ci-badge]: https://github.com/Saul-Mirone/milkdown/actions/workflows/ci.yml/badge.svg
[ci-link]: https://github.com/Saul-Mirone/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/Saul-Mirone/milkdown
[license-badge]: https://img.shields.io/github/license/Saul-Mirone/milkdown
[discord-badge]: https://img.shields.io/discord/870181036041060352
[discord-link]: https://discord.gg/SdMnrSMyBX