类型doc- 插件- 标记下
用于 类型文件 使 TypeScript API 文档成为 Markdown 文件。 (默认情况下,TypeDoc会使API文档成为一个网页,例如HTML文件
这有什么用?
该插件将默认的 HTML 主题替换为内置的 Markdown 主题并曝光一些额外的选项.
如果需要将文档包含在项目README文件,维基和静态站点生成器中,则有用.
安装
npm install --save-dev typedoc typedoc-plugin-markdown
使用量
用法与文献记载的相同 类型文件。 。 。 .
typedoc --plugin typedoc-plugin-markdown --out docs src/index.ts
选项
此插件提供了超出正常选项的额外选项 由类型Doc提供页: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。 。 。 .
许可证
麻省理工学院
关于 @convex-dev/typedoc-plugin-markdown 的常见问题
@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 和提交记录判断。