标签: compodoc

我在我的 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

经过一番挖掘之后，我仍然不知道Compodoc是否可以从打字稿注释生成markdown文档。Visual Studio Team Services Wiki功能仅支持markdown文件。如果它支持生成降价文档，那么CLI选项是什么？

我试图用现有的compodoc文档添加其他侧面导航菜单。

我可以像下面这样。

menu-wc.js

<li class="link">
    <a href="dependencies.html" data-type="chapter-link">
       <span class="icon ion-ios-list"></span>Custom Change
    </a>
</li>

当我们使用此npm命令更新文档时

compodoc -p src/tsconfig.app.json

更改已消失。每次执行此命令时，都会重新创建main-wc.js文件。

有什么方法可以自定义compodoc文档？

I started to use compodoc + storybook in a Angular 9 project.

Installed all the dependencies and Storybook is working fine, but for some reason the documentation.json generated by compodoc is empty, like this:

{
    "pipes": [],
    "interfaces": [],
    "injectables": [],
    "classes": [],
    "directives": [],
    "components": [],
    "modules": [],
    "miscellaneous": [],
    "routes": [],
    "coverage": {
        "count": 0,
        "status": "low",
        "files": []
    }
}

The command I'm using is:

compodoc -p .storybook/tsconfig.json -e json -d ./.storybook

And my tsconfig.json is:

{ …

我正在使用 Compo-doc 来记录我的 Angular 2 应用程序。在我的应用程序的目录结构中成功创建文档文件夹后，当我尝试通过命令访问浏览器上的文档时，默认情况下它会在“localhost:8080”端口上打开。我们已经将 8080 端口用于微服务。所以我需要更改文档渲染的端口。任何人都可以帮我解决这个问题吗？