Milkdown：重塑 Markdown 编辑体验的开源利器【实时预览你的 markdown 内容】倍儿爽！

Milkdown：重塑 Markdown 编辑体验的开源利器

在当下的 Markdown 编辑工具领域，Typora、tui.editor 等早已凭借各自优势占据一席之地。但 Milkdown 的出现，为开发者带来了一种全新的可能性 ------ 一个兼具强大功能与高度灵活性的开源解决方案，让打造专属编辑器不再是难题。

优点

完全免费

Milkdown 的核心魅力首先体现在开源与易集成上。不同于 Notion 等商业应用，它完全免费且开源，开发者可在合法范围内将其无缝集成到各类平台，无需担忧授权限制，为项目省下宝贵的成本与时间。

插件即功能

插件驱动架构是 Milkdown 的另一大亮点。它将每一项功能都封装为独立插件，开发者能按需挑选，避免冗余功能拖慢项目。无论是基础的格式化工具，还是个性化的 vim 快捷键映射，都能通过插件轻松实现，甚至可自主开发插件满足独特需求。

必须可靠

可靠性方面，Milkdown 依托 Prosemirror 和 Remark 这两大成熟工具。二者在行业中历经考验，拥有庞大社区支持，这为 Milkdown 提供了坚实的技术根基，也让开发者能便捷复用其社区的插件资源，加速开发进程。

灵活的主题控制

此外，作为 "无头组件"，Milkdown 赋予开发者对样式的完全掌控权。通过 npm 即可获取各类主题和插件，轻松实现界面定制，让编辑器既能契合项目风格，又能带来出色的视觉体验。

支持各大框架

对于追求灵活、可控且低成本的开发者而言，Milkdown 无疑是构建专属 Markdown 编辑工具的理想之选。

怎么使用

想直接看 milkdown 官网直接戳此 jump

简单 demo 获取

安装依赖

shell 复制代码

npm install @milkdown/react @milkdown/kit

使用 MilkdownProvider 包裹你的应用

tsx 复制代码

// app.tsx
import { Milkdown, MilkdownProvider, useEditor } from "@milkdown/react";

export function rootContainer(container: React.ReactNode) {
  return (
    <ConfigProvider prefixCls="freedom" theme={systemTheme}>
      <MilkdownProvider>
        <ErrorBoundary fallback={<Result status="error" title="Ops something wrong" />}>
          {container}
          <ClickToComponent
            pathModifier={(path: string) => {
              const projectPath = process.env.PROJECT_PATH

              return !path.startsWith('/') && projectPath
                ? `${process.env.PROJECT_PATH}/${path}`
                : path
            }}
          />
        </ErrorBoundary>
      </MilkdownProvider>
    </ConfigProvider>
  )
}

写一个 page

tsx 复制代码

// milkdown.tsx
import type { FC } from 'react'

import { Crepe } from '@milkdown/crepe'
import { Milkdown, useEditor, useInstance } from '@milkdown/react'
import { getMarkdown } from '@milkdown/utils'

import '@milkdown/crepe/theme/common/style.css'
import '@milkdown/crepe/theme/frame.css'

const markdown = `# Milkdown React Crepe

> You're scared of a world where you're needed.

This is a demo for using Crepe with **React**.`

const MilkdownEditor: FC = () => {
  const [isLoading, getInstance] = useInstance()

  useEditor((root) => {
    const crepe = new Crepe({
      root,
      defaultValue: markdown,
    })
    return crepe
  }, [])

  return (
    <div>
      <button
        type="button"
        onClick={() => {
          if (isLoading) {
            console.log('Milkdown isLoading:', isLoading)
          } else {
            const editor = getInstance()
            const content = editor?.action?.(getMarkdown())
            console.log('Milkdown content:', content)
          }
        }}
      >
        {isLoading ? 'Read' : 'Edit'}
      </button>
      <Milkdown />
    </div>
  )
}

export default MilkdownEditor

Milkdown：重塑 Markdown 编辑体验的开源利器【实时预览你的 markdown 内容】倍儿爽！