Stack Overflow
Stack Overflow

Questions tagged [compodoc]

33 questions
7
votes
1 answer

Can Compodoc generate markdown documentation, as opposed to its default HTML documentation?

After a bunch if digging, I still can't figure out if Compodoc can generate markdown documentation from typescript comments. The Visual Studio Team Services Wiki feature only supports markdown files. If it does support generating markdown…
juliet
  • 421
  • 3
  • 13
6
votes
1 answer

How to customize Compodoc Angular documentation?

I have tried to add additional side nav menus with existing compodoc documentation. I could do that like below. menu-wc.js
  • Cegone
    • 489
    • 1
    • 9
    • 23
    • 6
    votes
    3 answers

    compodoc: command not found

    I installed the documentation tool "Compodoc" in my Angular application. First, I installed the tool globally and in my project npm install -g @compodoc/compodoc npm install --save-dev @compodoc/compodoc I added the command to my package.json file…
    Sakolzer
    • 395
    • 5
    • 9
    5
    votes
    2 answers

    Empty documentation.json in Compodocs + Storybook + Angular 9

    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":…
    dvc.junior
    • 332
    • 6
    • 16
    4
    votes
    1 answer

    How to disable the dark mode in compodoc for angular?

    Am totally new to compodoc, with the newer version of dompodoc, dark mode is supported out of the box. And while checking the their documentation, I couldn't find any option to disable it. Am currently generating the documents using the following…
    leox
    • 1,315
    • 17
    • 26
    4
    votes
    0 answers

    Angularjs (1) types (ng.*) in compodoc are undefined

    Can you help me with next problem. I have a class: export class MyClass { public static $inject: string[] = [ "$element", "$scope" ]; constructor( private $element: ng.IAugmentedJQuery, private $scope:…
    Rostyslav Paslavskyy
    • 49
    • 1
    3
    votes
    1 answer

    Can't exclude directory in documentation coverage [compodoc]

    I generate documentation with compodoc, I would like to exclude some files/directories from the documentation coverage I added the exclude property of tsconfig.json file. "exclude": [ "node_modules", "*.spec.ts", …
    Caro
    • 612
    • 5
    • 10
    3
    votes
    0 answers

    How to get Angular routes information like Compodoc? (in compile time)

    Can anyone guide me on how to gather information about routes in Angular like Compodoc? (in compile time) How they get info in the Angular Compodoc? Does exist any specific functionally for this purpose? Some information such as: Route names…
    HamedFathi
    • 3,667
    • 5
    • 32
    • 72
    3
    votes
    1 answer

    compodoc not generating graph due to the memory issue

    Running command 'npm run compodoc' and saw this issue: Error during graph generation: : abort("Cannot enlarge memory arrays. Either (1) compile with -s TOTAL_MEMORY=X with X higher than the current value 16777216, (2) compile with -s…
    NewJake
    • 33
    • 7
    2
    votes
    1 answer

    Compodoc Documentation Coverage Statement Numbers Meaning (1/3, 1/2, etc...)

    I am using compodoc for an Angular app and using the Documentation Coverage to ensure I am fully documenting the app. When the Statement value is 0/3 or 1/2, how do I determine what documentation is missing from the /**... comments in the…
    cbilliau
    • 987
    • 9
    • 20
    2
    votes
    1 answer

    How to generate documentation file(pdf or doc) using Compodoc?

    I am using Compodoc for documentation my Angular application How to generate documentation file(pdf or doc) using Compodoc
    John Doe
    • 3,794
    • 9
    • 40
    • 72
    2
    votes
    0 answers

    How to include compodoc files in a Angular project

    I am creating app using angular 6 and I would like add the documentation (build with compodoc) in this app but I don't know how add the JS files in the template like in the index.html of compodoc. I know that I must do some thing like that : var…
    Canitie
    • 21
    • 1
    2
    votes
    2 answers

    Need to change port for document opening in Compodoc

    I am using Compo-doc for documenting my Angular 2 application. After successful creation of documentation folder in directory structure of my application, when I am trying to access the Document on browser through the command, by default it opens on…
    Adynh
    • 219
    • 4
    • 19
    1
    vote
    1 answer

    Documentation Coverage Compodoc and Angular

    As the title says I am using compodoc with Angular and it is working great so far. My problem lies with the calculation of the code coverage. Is there a way to modify this calculation? I don't want to document the meaning of every variable if i…
    GreenW0lf
    • 11
    • 2
    1
    vote
    2 answers

    I can't insert quote, in the example section in compodoc

    i'm documenting my project with 'compodoc' and i like this tool but i get a error visual when i try insert a quote. i have this comment /** * crea un arreglo de tamaño n * * @example * *ngFor="let item of 2 | numberToArray" * *…
    renato cohaila
    • 88
    • 7
    1
    2 3