# @convex-dev/typedoc-plugin-markdown 中文文档

规范地址：https://npmcn.com/package/%40convex-dev/typedoc-plugin-markdown/

版本：3\.15\.6
npm 元数据更新时间：2026-10-07T00:51:49.740Z
中文译文更新时间：2026-11-10T18:00:22.114Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40convex-dev/typedoc-plugin-markdown
原文对照：https://npmcn.com/package/%40convex-dev/typedoc-plugin-markdown/?lang=original
项目主页：https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-plugin-markdown
源码仓库：https://github.com/tgreyuk/typedoc-plugin-markdown

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

- 包体积（解压后）：134 kB，93 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- peer 依赖：typedoc \>=0\.24\.0
- 首次发布：2023-03-02T17:56:26.677Z
- 最新版本发布：2023-05-19T20:39:38.042Z
- 近 30 天下载量：10649（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 0 个）

## 中文简介

TypeDoc 的插件,可以让 TypeScript API 文档在 Markdown 中生成.

## 安装

```sh
npm install @convex-dev/typedoc-plugin-markdown
```

也可以使用：`pnpm add @convex-dev/typedoc-plugin-markdown`、`yarn add @convex-dev/typedoc-plugin-markdown`、`bun add @convex-dev/typedoc-plugin-markdown`

## README

# 类型doc- 插件- 标记下

用于 [类型文件](https://github.com/TypeStrong/typedoc) 使 TypeScript API 文档成为 Markdown 文件。 (默认情况下,TypeDoc会使API文档成为一个网页,例如HTML文件

[![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown.svg)](https://www.npmjs.com/package/typedoc-plugin-markdown) [![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml)

## 这有什么用?

该插件将默认的 HTML 主题替换为内置的 Markdown 主题并曝光一些额外的选项.

如果需要将文档包含在项目README文件,维基和静态站点生成器中,则有用.

## 安装

```bash
npm install --save-dev typedoc typedoc-plugin-markdown
```

## 使用量

用法与文献记载的相同 [类型文件](https://typedoc.org/guides/installation/#command-line-interface)。 。 。 .

```bash
typedoc --plugin typedoc-plugin-markdown --out docs src/index.ts
```

## 选项

此插件提供了超出正常选项的额外选项 [由类型Doc提供](https://typedoc.org/guides/options/)页:1 注意任何自定义 HTML 主题的香草类型Doc 选项将被忽略 .

-   `--entryDocument<string>`  
    条目文档的文件名. 默认为 `README.md`。 。 。 .
-   `--hideBreadcrumbs<boolean>`  
    不要在模板标题中制作面包屑 。 默认为 `false`。 。 。 .
-   `--hideInPageTOC<boolean>`  
    不提供页面目录项目 。 默认为 `false`。 。 。 .
-   `--hideMembersSymbol<boolean>`  
    不要为阶级成员添加特殊符号. 默认为 `false`。 。 。 .
-   `--publicPath<string>`  
    指定所有 urls 的基础路径。 如果未定义的urls将是相对的. 默认为 `.`。 。 。 .
-   `--namedAnchors<boolean>`  
    使用 HTML 命名的锚标记来进行不指定标题 ID 的执行 。 默认为 `false`。 。 。 .
-   `--preserveAnchorCasing<boolean>`  
    保留锚地id外壳,供执行时使用。 默认为 `false`。 。 。 .

## 许可证

[麻省理工学院](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/LICENSE)

## 常见问题

### @convex-dev/typedoc-plugin-markdown 是什么？

TypeDoc 的插件,可以让 TypeScript API 文档在 Markdown 中生成\.

### 如何安装 @convex-dev/typedoc-plugin-markdown？

在项目目录运行 npm install @convex-dev/typedoc-plugin-markdown，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：typedoc（\>=0\.24\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @convex-dev/typedoc-plugin-markdown 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/convex-dev\_\_typedoc-plugin-markdown 是否存在。

### @convex-dev/typedoc-plugin-markdown 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @convex-dev/typedoc-plugin-markdown 可以商用吗？

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

### @convex-dev/typedoc-plugin-markdown 的下载量有多少？

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

### @convex-dev/typedoc-plugin-markdown 还在维护吗？

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