# @create-markdown/core 中文文档

规范地址：https://npmcn.com/package/%40create-markdown/core/

版本：2\.0\.3
npm 元数据更新时间：2026-04-09T16:53:13.512Z
中文译文更新时间：2026-11-10T23:48:18.707Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40create-markdown/core
原文对照：https://npmcn.com/package/%40create-markdown/core/?lang=original
项目主页：https://github.com/BunsDev/create-markdown/tree/main/packages/core
源码仓库：https://github.com/BunsDev/create-markdown

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：383 kB，25 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：0 个
- 首次发布：2026-01-28T00:32:15.611Z
- 最新版本发布：2026-04-09T16:53:13.359Z
- 近 30 天下载量：9206（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 6 个）

## 中文简介

零依赖性的以块为基础的分解和序列化

## 安装

```sh
npm install @create-markdown/core
```

也可以使用：`pnpm add @create-markdown/core`、`yarn add @create-markdown/core`、`bun add @create-markdown/core`

## README

# 创建- markdown/ 核心

以块为主的标记下分解和序列化,零依赖.

## 安装

```bash
# Using pnpm
pnpm add @create-markdown/core

# Using npm
npm install @create-markdown/core

# Using yarn
yarn add @create-markdown/core

# Using pnpm
pnpm add @create-markdown/core
```

## 快速启动

### 将下划为块

```typescript
import { parse } from '@create-markdown/core';

const blocks = parse(`# Hello World

This is **bold** and *italic* text.

- Item one
- Item two
`);
```

### 程序创建块

```typescript
import { h1, paragraph, bulletList, bold, italic, spans } from '@create-markdown/core';

const blocks = [
  h1('My Document'),
  paragraph(spans(
    bold('Important: '),
    { text: 'This is ', styles: {} },
    italic('really'),
    { text: ' cool!', styles: {} }
  )),
  bulletList(['First item', 'Second item', 'Third item']),
];
```

### 将块序列化到 Markdown

```typescript
import { stringify, h1, paragraph, codeBlock } from '@create-markdown/core';

const markdown = stringify([
  h1('Hello'),
  paragraph('World'),
  codeBlock('console.log("Hi!");', 'javascript'),
]);
```

## 块类型

| 类型 | 工厂函数 | 说明 |
| --- | --- | --- |
| `paragraph` | `paragraph(content)` | 文本段落 |
| `heading` | `heading(level, content)` 或者说 `h1`\- 说吧`h6` | 标题 |
| `bulletList` | `bulletList(items)` | 无序列表 |
| `numberedList` | `numberedList(items)` | 排序列表 |
| `checkList` | `checkList(items)` | 带有复选框的任务列表 |
| `codeBlock` | `codeBlock(code, language?)` | 栅栏码块 |
| `blockquote` | `blockquote(content)` | 块引号 |
| `image` | `image(url, alt?)` | 图像 |
| `divider` | `divider()` | 水平规则 |
| `table` | `table(headers, rows)` | 有信头的表格 |
| `callout` | `callout(type, content)` | 点名/宣传 |

## API 参考

### 分析

-   `parse(markdown)` - 将标记字符串分析成块
-   `markdownToBlocks(markdown, options?)` - 有选项的全解析器
-   `markdownToDocument(markdown)` - 分析文档对象

### 序列化

-   `stringify(blocks)` - 将区块序列化以标记下
-   `blocksToMarkdown(blocks, options?)` - 带选项的全序列器
-   `documentToMarkdown(doc)` - 将文档序列化

### 文件操作

-   `createDocument(blocks?, options?)` - 创建一个新文档
-   `insertBlock(doc, block, index?)` - 在位置上插入块
-   `appendBlock(doc, block)` - 在末尾添加块
-   `removeBlock(doc, blockId)` - 通过ID删除块
-   `updateBlock(doc, blockId, updates)` - 更新块属性
-   `moveBlock(doc, blockId, newIndex)` - 重排区块
-   `findBlock(doc, blockId)` - 以身份证查找块

## 许可证

麻省理工学院

## 常见问题

### @create-markdown/core 是什么？

零依赖性的以块为基础的分解和序列化

### 如何安装 @create-markdown/core？

在项目目录运行 npm install @create-markdown/core，或使用 pnpm add / yarn add / bun add。

### @create-markdown/core 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @create-markdown/core 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @create-markdown/core 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @create-markdown/core 可以商用吗？

@create-markdown/core 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @create-markdown/core 的下载量有多少？

根据 npm 官方下载统计，@create-markdown/core 在 2026/10/11 – 2026/11/09 这 30 天内被下载 9,206 次，日均约 307 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @create-markdown/core 还在维护吗？

最新版本 2\.0\.3 发布于 2026/04/10（7 个月前）；至今共发布 6 个版本，其中过去 12 个月发布了 6 个；首次发布于 2026/01/28。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。