angular - 如何自定义 Compodoc Angular 文档?

标签 angular npm code-documentation compodoc

我尝试在现有的 compodoc 文档中添加额外的侧边导航菜单。

我可以像下面那样做。

菜单-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

最佳答案

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

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

关于angular - 如何自定义 Compodoc Angular 文档?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/56124886/

相关文章:

angular - 使用@ngx-translate/core同时翻译不同语言的两个字符串?

ionic-framework - "ionic cordova plugin add"和 "npm install @ionic-native/plugin --save"之间的区别

javascript - ReactJS 编写无状态函数注释

javascript - 如何在 JavaScript 中记录返回值

angular - 如何轻松地将 Observable 转换或分配给 Behavior Subject,以便其他组件可以共享它

angular - ionic2 不创建 webpack.config.js

node.js - 安装没有依赖的 npm 包

objective-c - Xcode 没有为 Objective-C 代码正确格式化文档注释

angular - 如何优雅地从 ActivatedRouteSnapshot 获取完整的 url?

node.js - 我应该硬编码对我的node_modules 文件夹的引用吗?