node.js - apiDoc 的 package.json 放在哪里

Question

我希望使用apiDoc来记录 WebAPI 接口。apiDoc 文档提到使用package.json文件来指定项目名称和最新 API 版本等内容。不幸的是，我无法让它工作。这个文件应该放在哪里？我已尝试将其放置在包含文档代码的文件夹中、包含生成的文档代码的文件夹中以及调用 apiDoc 的文件夹中，但在所有情况下我都会收到以下消息：

apidoc: No package.json found!

有没有我在这里没有找到的技巧？

Answer 1

将其放入项目的根目录（源文件所在的位置）。在您的根目录中运行 apidoc。

Answer 2

如果您使用gulp-apidocor grunt-apidoc，您可以使用 config-c标志来指定package.jsonor的位置apidoc.json。像这样：

apidoc({
      src: ["../pathToSrc"],
      dest: "./docs",
      config: "./pathToConfig"
    },done);