Code Monkey home page Code Monkey logo

compodoc-demo-todomvc-angular's Issues

Custom show/Hide sections

Would be nice to be able to exclude some portions of each page, either with css and selecting sections within each page and use a display:none , so marking sections with id's or classes, or some exclude parameter for the build.

I Have Error When Try To Run compodoc Comand

When I Try To Run the compodoc comand I Get Below Error:

$ npm run compodoc

> [email protected] compodoc E:\Web Application\compodoc-demo-todomvc-angular
> compodoc --config .compodocrc

E:\Web Application\compodoc-demo-todomvc-angular\node_modules\cosmiconfig\dist\readFile.js:38
    throw err;
    ^

Error: ENOENT: no such file or directory, open 'E:\Web Application\compodoc-demo-todomvc-angular\.compodocrc'
    at Object.openSync (fs.js:440:3)
    at Object.readFileSync (fs.js:342:35)
    at Function.readFileSync [as sync] (E:\Web Application\compodoc-demo-todomvc-angular\node_modules\cosmiconfig\dist\readFile.js:33:15)
    at E:\Web Application\compodoc-demo-todomvc-angular\node_modules\cosmiconfig\dist\createExplorer.js:291:32
    at cacheWrapper (E:\Web Application\compodoc-demo-todomvc-angular\node_modules\cosmiconfig\dist\cacheWrapper.js:14:18)
    at Explorer.loadSync (E:\Web Application\compodoc-demo-todomvc-angular\node_modules\cosmiconfig\dist\createExplorer.js:290:12)
    at CliApplication.start (E:\Web Application\compodoc-demo-todomvc-angular\node_modules\@compodoc\compodoc\dist\index-cli.js:179:51)
    at Object.<anonymous> (E:\Web Application\compodoc-demo-todomvc-angular\node_modules\@compodoc\compodoc\bin\index-cli.js:6:5)
    at Module._compile (internal/modules/cjs/loader.js:959:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:995:10) {
  errno: -4058,
  syscall: 'open',
  code: 'ENOENT',
  path: 'E:\\Web Application\\compodoc-demo-todomvc-angular\\.compodocrc'
}
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] compodoc: `compodoc --config .compodocrc`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] compodoc script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

Compodoc Doesn't Work

I Add Supported Comment To My Project But Steel The Compodoc Doesn't Generate a Real Doc, For Example, I Have This Interface:

/**
 * A Menu Item Interface Just Use For Sidebar Menu
 */
export interface MenuItems {
  menu_name: string;
  menu_link: string;
  menu_icon_name: string;
}

But when i run compodoc -p tsconfig.app.json --serve --open --watch --port 4300 i can't see my interface page inside generated doc

Error running the demo locally

Hello,
I wanted to try this compodoc demo locally but I'm getting an error.
To replicate:
npm install
npm run compodoc

> compodoc-demo-todomvc-angular@0.0.0 compodoc C:\Users\simone.casarosa\Documents\workspaces\compodoc-demo-todomvc-angular-master
> compodoc --config .compodocrc

C:\Users\simone.casarosa\Documents\workspaces\compodoc-demo-todomvc-angular-master\node_modules\cosmiconfig\dist\readFile.js:38
    throw err;
    ^

Error: ENOENT: no such file or directory, open 'C:\Users\simone.casarosa\Documents\workspaces\compodoc-demo-todomvc-angular-master\.compodocrc'
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the compodoc-demo-todomvc-angular@0.0.0 compodoc script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

Running npm run doc throws an error as well

1.1.11

TypeScript version used by Compodoc : 2.9.1

TypeScript version of current project : 3.5.3

Node.js version : v10.16.3

Operating system : Windows 10

[10:26:09] No configuration file found, switching to CLI flags.
[10:26:09] Provided source folder Angular was not found in the current directory
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! compodoc-demo-todomvc-angular@0.0.0 doc: `compodoc -p tsconfig.app.json -a screenshots -n 'TodoMVC Angular documentation' --includes additional-doc`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the compodoc-demo-todomvc-angular@0.0.0 doc script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

It seems like the compodoc configuration file is missing, or is there something else I'm missing?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.