Need help with jaguarjs-jsdoc?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

davidshimjs
201 Stars 138 Forks MIT License 34 Commits 34 Opened issues

Description

A Template of jsdoc for jaguar.js project

Services available

!
?

Need anything else?

Contributors list

Jaguar.js template for JSDoc 3

Usage

  1. If you want to create documentations with sample files, you can use commands below.

    $ npm install
    $ grunt demo
    
  2. You can see any output related jsdoc process with a

    --debug
    flag.
    $ grunt demo --debug
    
  3. If you already have jsdoc system, you can use this project as jsdoc template.

    $ jsdoc -t `project folder` -c `configuration file` `source files` `README.md file`
    

conf.json

You can set options for customizing your documentations.

"templates": {
    "applicationName": "Demo",
    "disqus": "",
    "googleAnalytics": "",
    "openGraph": {
        "title": "",
        "type": "website",
        "image": "",
        "site_name": "",
        "url": ""
    },
    "meta": {
        "title": "",
        "description": "",
        "keyword": ""
    },
    "linenums": true
}

License

This project under the MIT License. and this project refered by default template for JSDoc 3.

Bitdeli Badge

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.