TypeDoc 抱怨“找不到module”

IT技术 reactjs typescript documentation typedoc
2021-05-21 18:58:10

我有一个基于 Typsecript 的 React 应用程序。它工作正常,但我想将 TypeDoc(想想 Typescript 的 JSDoc)添加到混合中。安装后,我从命令行运行它(在我测试时只处理一个文件):

typedoc --module commonjs --jsx react --out ../docs/ ./src/components/404/404.tsx

我收到一个错误:

Error: /path/to/project/src/components/404/404.tsx(0)
 Cannot find module 'react'.

实际上,React 已安装。我曾尝试运行全局和本地安装的 TypeDoc,但没有任何区别(认为全局安装可能无法找到正确的 node_modules)。该应用程序从 Typescript 编译并运行良好......没有关于缺少module或类型定义的抱怨......只是无法通过 TypeDoc 工作。

有什么建议?似乎为了在基于 Typescript 的 React 项目中生成文档,TypeDoc 是镇上唯一的游戏,所以我有点卡住了。

1个回答

可能对你有帮助:

'node ./node_modules/typedoc/bin/typedoc ' +
(path || './src/scripts/') +
'--exclude node_modules ' +
'--ignoreCompilerErrors ' +
'--experimentalDecorators ' +
'--target ES6 ' +
'--jsx react'

我注意到 package.json 中有一些默认主题错误:

-- "typedoc-default-themes": "0.4.0",

++ "typedoc-default-themes": "0.3.4",