Where communities thrive

  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
Repo info
  • Oct 17 06:57
    vogloblinsky closed #1132
  • Oct 16 16:51
    ddubrava edited #1132
  • Oct 16 16:48
    ddubrava opened #1132
  • Oct 15 09:26
    vogloblinsky closed #868
  • Oct 15 09:25
    vogloblinsky closed #1127
  • Oct 14 14:42
    hichemfantar edited #1127
  • Oct 14 09:50
    stale[bot] unlabeled #868
  • Oct 14 09:50
    vogloblinsky closed #1128
  • Oct 14 09:20
    vogloblinsky milestoned #1131
  • Oct 14 09:20
    vogloblinsky labeled #1131
  • Oct 14 09:20
    vogloblinsky opened #1131
  • Oct 14 09:20
    vogloblinsky assigned #1131
  • Oct 14 06:55
    vogloblinsky milestoned #1130
  • Oct 13 15:19
    vogloblinsky closed #1130
  • Oct 13 10:25
    sanisoclem edited #1130
  • Oct 13 10:24
    sanisoclem opened #1130
  • Oct 13 10:24
    sanisoclem labeled #1130
  • Oct 13 10:24
    sanisoclem assigned #1130
  • Oct 12 22:20
    stale[bot] labeled #1116
  • Oct 12 09:22
    vogloblinsky reopened #868
steve greensill
i.e. like have them reside in a ./docs/folder instead of the project root?
Vincent Ogloblinsky
@greenstevester yes it is in the pipeline. i have two strategies, manage that like TypeDoc does with an internal algorithm, or use Tsdoc (https://github.com/microsoft/tsdoc)
no there is no way to override the default location, i can add a flag for that, could you submit an issue for that ?
steve greensill
@vogloblinsky - sorry for the delay, yes I will submit an issue
@vogloblinsky - compodoc/compodoc#857
Vincent Ogloblinsky
David Lorenz
I created a PR for the issue I just created compodoc/compodoc#905
David Lorenz
Even tho technically I know it will properly run through all tests the issue is that I was not able to run the npm test. npm build worked properly but for npm test it showed multiple occurences of errors with the viz.js library
CLI include with tsconfig
    when specific files (glob) are included in tsconfig
^Cshell error: (node:21171) V8: /Users/lorendav/dev/compodoc/node_modules/viz.js/viz.js:33 Invalid asm.js: Function definition doesn't match use

      104) "before all" hook for "should create files included"
      105) "before all" hook for "should create files included"
Hi every body, can any one help me about this => Invalid asm.js: Function definition doesn't match use
Manuel Pacheco
People I got a question: is https://compodoc.github.io/compodoc-demo-todomvc-angular/interfaces/ClockInterface.html working properly with rendering the example code? I think there is a bug with it.
Kersten Lorenz
What a about a new release? Especially to include compodoc/compodoc@baf122c
@vogloblinsky related to compodoc/compodoc#145 is there any way to order left menu items by configurations, like heading1 -> item1, item 2, heading 2 -> item1...
hello, is it possible to use compodoc only to render documentation for components that are exported from certain modules?
Purushottam Jha
These properties don't seem to be working
Anyone knows why providers are not added under "injectables" documentation?
Sven Büchner
What happened to this project in the past since the beginning of 2020? Seems like developmen has stopped, can we help in some way or did everyone migrate to a better solution?
3 replies
José Gomes
Hi all! I just installed compodoc and it doesn't include directives with no options.
In angular 10 it's mandatory to have the directive decorator on abstract classes in order to use input and output properties
José Gomes
Is there any way to make it work?
Selam Getachew Woldetsadick
is compodoc dead. Last time it was updated was a year ago?
Vincent Ogloblinsky
@swoldetsadick yes and no. OSS was difficult for me this year...
Karl Gunnar Jonsson
Hi, I would like to hide/remove the file info ... tried importing a custom css, but then there where no specific selectors I could easily get hold of this section... is there any other way?
Vincent Ogloblinsky
not right now
fill a new issue for this desired feature
Karl Gunnar Jonsson
Will do thanks :)
Kalle Wikstrand
Hello! When running the generator for an Angular 11 application I only get it to parse the main file. I noted in the documentation it says it only supports 10.x. Is this the case or am I doing something wrong?
Kalle Wikstrand
Got it working in another Angular 11 application (with the exception of the routes) so I assume there is a structural difference between the two applications and that the above issue had nothing to do with versions. Still if you could add a comment it would be greatly appreciated.

I have next error during compodoc run in angular (npx compodoc -p tsconfig.app.json src)

How can I fix it?

Ooops error during main graph generation, moving on next part with main graph disabled : : Error [ERR_REQUIRE_ESM]: Must use import to load ES Module: /usr/local/lib/node_modules/@compodoc/compodoc/node_modules/@aduh95/viz.js/sync/index.js
require() of ES modules is not supported.
require() of /usr/local/lib/node_modules/@compodoc/compodoc/node_modules/@aduh95/viz.js/sync/index.js from /usr/local/lib/node_modules/@compodoc/compodoc/node_modules/@compodoc/ngd-transformer/dist/engines/dot/dot.js is an ES module file as it is a .js file whose nearest parent package.json contains "type": "module" which defines all .js files in that package scope as ES modules.
Instead rename index.js to end in .cjs, change the requiring code to use import(), or remove "type": "module" from /usr/local/lib/node_modules/@compodoc/compodoc/node_modules/@aduh95/viz.js/package.json.

Amaury Lapaque
hi @mkarpovets you can resolve this error by using --disableGraph but this will no longer generate routing graphs... needs a fix from @vogloblinsky
Hi @vogloblinsky any idea when will you release 1.2.0 ? image.png
Vincent Ogloblinsky
@WikstrandKalle_twitter i have updated the doc, you just have to create a tsconfig.doc.json file, with include: « src/*/.ts »

Hello everyone,

Is there a way to include the compodoc documentation/index.html as a route in the locally served application? Would that work?

Hi everyone, there is a way to hide some sections in the compodoc? Example we have "file", "metadata", "index"... Sometimes want to hide index and other "input" for example.
Hi, i need documentation generate angular cli 10
Hello all - is there a way to just generate the metadata as opposed to HTML?
Figured it out, --exportFormat json - thanks!
--exportFormat json doesn't seem to include module source code, is there a toggle I'm missing?
Vincent Ogloblinsky
may be this is an issue, feel free to submit an issue on github, thanks
Actually I did a few minutes ago then thought to ask here just in case
Thanks :)

I've added a PR for this:

But I cannot seem to run tests, so I've not been able to check. The only data I'm unsure of is the "methods" and whether that will map across nicely to a JSON element.

Brandon Miller
Hey all
any news on #1120 ?
@joshcomley Ihad the same problem