如何自定义Compodoc Angular文档?

时间:2019-05-14 07:15:42

标签: angular npm code-documentation compodoc

我尝试使用现有的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文档?

enter image description here

1 个答案:

答案 0 :(得分:0)

Compodoc支持添加新的侧边菜单元素,链接到现有的markdown文件   * https://compodoc.app/guides/tips-and-tricks.html#additional-documentation

此外,链接到每个组件的实际使用示例是一种有效的工具