6

我在 Angular 应用程序中安装了文档工具“Compodoc”。首先,我在全局和我的项目中安装了该工具

npm install -g @compodoc/compodoc
npm install --save-dev @compodoc/compodoc

我使用以下行将命令添加到“脚本”区域中的 package.json 文件中

"compodoc": "./node_modules/.bin/compodoc -p src/tsconfig.app.json"

它使用以下命令为我生成了整个文档文件:

npm run compodoc

一切都很顺利,直到我尝试运行命令compodoc -s以在浏览器中查看文档。

compodoc: command not found
4

3 回答 3

5

只需运行“./node_modules/.bin/compodoc -s”

于 2017-11-30T13:11:32.170 回答
1

在你的 package.json 中,“compodoc”有你需要的选项,只需运行“npm run compodoc”。例如: “compodoc”:“./node_modules/.bin/compodoc -p tsconfig-compodoc.json -d docs -n \"我的文档名称\" --serve --port 3003 --theme postmark --hideGenerator - -手表”

它应该运行。希望它有所帮助。谢谢:)

于 2017-12-14T06:50:52.800 回答
1

为 Angular 9 用户添加这个:

告诉它在别处创建文档,这样如果您使用的是“w”文件夹,“ng serve”就不会被文档文件夹引起的更改弄糊涂

添加这个包。json 然后你可以运行'npm run compodoc'。此外,在 Angular 9 中,现在我看到我还必须指定要监视的文件夹 - '-w' 表示监视源文件夹。

“脚本”:{ “ng”:“ng”,“start”:“ng serve”,“build”:“ng build”,“test”:“ng test”,“lint”:“ng lint”,“ e2e": "ng e2e", "compodoc": "./node_modules/.bin/compodoc -p tsconfig.json -w ./src -s --output ../Path 你想要文档/文档的地方 --沉默的” },

于 2020-02-14T16:50:57.080 回答