我有一个基于Typsecript的反应应用程序。它工作正常,但我想添加TypeDoc(想想JSDoc for Typescript)混合。安装后我从命令行运行它(在我测试时只处理一个文件):
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编译并运行良好...没有关于缺少模块或类型defs的投诉...只是通过TypeDoc工作。
有什么建议吗?似乎为了在基于Typescript的React项目中生成文档,TypeDoc是城里唯一的游戏,所以我有点卡住了。
答案 0 :(得分:6)
可能对你有所帮助:
'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",