问题标签 [compodoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
0 回答
164 浏览

angularjs - compodoc 中的 Angularjs (1) 类型 (ng.*) 未定义

你能帮我解决下一个问题吗?我有一堂课:

通过 Compodoc,我创建了文档并得到了这个:

构造函数(MyClass:$element:未定义,$scope:未定义)

有人可以告诉我如何解决文档中不正确类型的问题吗?

0 投票
0 回答
428 浏览

angular - Angular 4中的Compodoc安装错误

我尝试为我的 Angular 4 应用程序安装 compodoc https://github.com/compodoc/compodoc

我的节点版本是:v6.11.1 npm 版本是v3.10.10 ,Os 是:Window6.1.7601 和 angular/cli 版本是1.2.6

安装时出现此错误

错误的屏幕截图

我尝试:这里的任何这些建议仍然没有安装在我的 Angular 应用程序中

0 投票
3 回答
2989 浏览

angular - compodoc:找不到命令

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

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

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

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

0 投票
1 回答
607 浏览

markdown - 在 Compodoc 中以 Markdown 语法高亮显示 & 符号

我正在尝试在 Markdown 中执行 SCSS 代码块,但无法显示 & 符号。

这是我到目前为止所尝试的结果:

&显示文本。

&显示我刚刚输入的文字。

&只显示一个空格。

0 投票
1 回答
650 浏览

compodoc - 在 compodoc 中使用另一个主题(邮戳)

我想将邮戳主题与 compodoc ( https://compodoc.github.io/website/guides/themes.html ) 一起使用。

但是,它不起作用!我已经试过了

我收到错误提供的源文件夹邮戳未在当前目录中找到

我必须下载主题吗?我在哪里可以找到它?

0 投票
2 回答
1634 浏览

documentation - 需要更改在 Compodoc 中打开文档的端口

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

0 投票
1 回答
804 浏览

angular - Compodoc 可以生成降价文档,而不是其默认的 HTML 文档吗?

经过一番挖掘后,我仍然无法弄清楚 Compodoc 是否可以从打字稿注释中生成降价文档。Visual Studio Team Services Wiki 功能仅支持 markdown 文件。如果它确实支持生成降价文档,那么 CLI 选项是什么?

0 投票
0 回答
336 浏览

angular - Compodoc --includes 选项示例

有人可以为我提供一个如何在 Compodoc 中使用 --includes 选项的示例。我想将所有 ts 文档包含在 ClientApp -> app 目录中,并在以下结构中设置我的应用程序文件:

  • ClientApp -> 应用程序(包含此文件夹下的所有 ts 文件)....
  • 包.json
  • tsconfig.json

我的 tsconfig.json 文件具有以下内容:

"compileOnSave": false, "include": [ "./ClientApp", "./wwwroot/ts" ],

我的 package.json 有以下内容:

我似乎找不到要遵循的“--includes”示例。

提前感谢您提供的任何帮助。

0 投票
1 回答
452 浏览

handlebars.js - 覆盖 compodoc 模板

您好,我正在使用compodoc 1.1.5 为我的 Angular 项目生成文档。Compodoc 提供了使用选项覆盖模板的能力--template folder_name。即使我不修改原始代码,我也尝试通过创建一个部分文件夹并将 menu.hbs 与原始 menu.hbs 中的代码(菜单完全消失)放入其中来覆盖菜单部分。我收到此错误

Uncaught SyntaxError: Invalid or unexpected token menu-wc.js:34

有没有人对覆盖模板的正确方法有任何想法

0 投票
0 回答
213 浏览

javascript - 如何在 Angular 项目中包含 compodoc 文件

我正在使用 angular 6 创建应用程序,我想在此应用程序中添加文档(使用 compodoc 构建),但我不知道如何在模板中添加 JS 文件,例如在 compodoc 的 index.html 中。

我知道我必须做这样的事情:

但在我的情况下,文件不是外部的,而是内部的,如果我放置这样的路径:

我有这个错误:

我如何在 Angular 应用程序中包含所有这些 js 文件?