# @astropub/md 中文文档

规范地址：https://npmcn.com/package/%40astropub/md/

版本：1\.0\.0
npm 元数据更新时间：2024-07-29T02:34:11.201Z
中文译文更新时间：2026-11-07T01:16:14.192Z
软件包许可：CC0-1\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40astropub/md
原文对照：https://npmcn.com/package/%40astropub/md/?lang=original
项目主页：https://github.com/astro-community/md
源码仓库：https://github.com/astro-community/md

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

- 包体积（解压后）：10 kB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@astrojs/markdown-remark ^5
- 首次发布：2022-08-25T03:57:00.548Z
- 最新版本发布：2024-07-29T02:34:11.029Z
- 近 30 天下载量：17636（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 0 个）

## 中文简介

在 Astro 中渲染任何 Markdown 内容

## 安装

```sh
npm install @astropub/md
```

也可以使用：`pnpm add @astropub/md`、`yarn add @astropub/md`、`bun add @astropub/md`

## README

# 天体标记 ![](https://jonneal.dev/astro-logo.svg)

**天体标记** 让您将任何 Markdown 内容输入 **[天体](https://astro.build/)**,可选择与任何现有配置相融合.

[![NPM Version](https://img.shields.io/npm/v/@astropub/md?color=%23444&label=&labelColor=%23CB0000&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjE1MCAxNTAgNDAwIDQwMCIgZmlsbD0iI0ZGRiI+PHBhdGggZD0iTTE1MCA1NTBoMjAwVjI1MGgxMDB2MzAwaDEwMFYxNTBIMTUweiIvPjwvc3ZnPg==&style=for-the-badge)](https://www.npmjs.com/package/@astropub/md) [![NPM Downloads](https://img.shields.io/badge/dynamic/json?url=https://api.npmjs.org/downloads/point/last-week/@astropub/md&query=downloads&label=%E2%87%93+week&color=%23444&labelColor=%23EEd100&style=for-the-badge)](https://www.npmjs.com/package/@astropub/md) [![Open in StackBlitz](https://img.shields.io/badge/-Open%20in%20Stackblitz-%231374EF?color=%23444&labelColor=%231374EF&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjEwIDggMTIgMTgiIGhlaWdodD0iMTgiIGZpbGw9IiNGRkYiPjxwYXRoIGQ9Ik0xMCAxNy42aDUuMmwtMyA3LjRMMjIgMTQuNGgtNS4ybDMtNy40TDEwIDE3LjZaIi8+PC9zdmc+&style=for-the-badge)](https://stackblitz.com/github/astro-community/md)

```astro
---
import { Markdown } from '@astropub/md'
---
<Markdown of={`# Hi, there!` /* Renders `<h1>Hi, there!</h1>` */} />
```

```astro
---
import { markdown } from '@astropub/md'
---
{
  /* Renders `<h1>Hi, there!</h1>` */
  await markdown(`# Hi, there!`)
}
```

## 使用量

添加 **天体标记** 你的项目.

```shell
npm install @astropub/md
```

使用 **天体标记** 在你的项目.

```astro
---
import { markdown } from '@astropub/md'
---
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width" />
    <title>Astro</title>
  </head>
  <body>
    {await markdown(
`# Hi, there!

Welcome to my _website_.`
    )}
  </body>
</html>
```

选择性地整合 **天体标记** 使用您的 Astro 配置 .

```js
// astro.config.js
import { defineConfig } from 'astro/config'
import markdownIntegration from '@astropub/md'

export default defineConfig({
  integrations: [
    markdownIntegration(),
  ],
  markdown: {
    remarkPlugins: [],
    rehypePlugins: [],
    // syntaxHighlight: 'shiki'
    // syntaxHighlight: 'prism'
  }
})
```

现在 `markdown` 配置自动应用到 `<Markdown>` 组件和组件 `markdown()` 函数.

使用 `markdown.inline()` 或者说 `<Markdown.Inline>` 用于处理文本的短串,而不包含相邻段落.

```astro
---
import { Markdown } from '@astropub/md'
---
<Markdown.Inline of={
  /* Renders `Welcome to my <em>website</em>.` */
  `Welcome to my _website_.`
} />
```

```astro
---
import { markdown } from '@astropub/md'
---
{await markdown.inline(
  /* Renders `Welcome to my <em>website</em>.` */
  `Welcome to my _website_.`
)}
```

  

慢慢来!

* * *

想多学点吗? 读取 [Astro 文档](https://github.com/withastro/astro) 或跳入 [Astro Discord (Astro Discord) 时尚主题 :](https://astro.build/chat)。 。 。 .

## 常见问题

### @astropub/md 是什么？

在 Astro 中渲染任何 Markdown 内容

### 如何安装 @astropub/md？

在项目目录运行 npm install @astropub/md，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@astrojs/markdown-remark（^5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @astropub/md 支持 TypeScript 吗？

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

### @astropub/md 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @astropub/md 可以商用吗？

@astropub/md 使用 CC0-1\.0 许可。作者放弃著作权，可不受限制地使用。以上为概括，不构成法律意见，请以许可原文为准。

### @astropub/md 的下载量有多少？

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

### @astropub/md 还在维护吗？

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