Noteworthy Programming Masterpiece

    jsdoc-sable

    0.0.2 • Public • Published

    Sable template for JSDoc 3

    ripped from jaguarjs-jsdoc then renamed it after another animal.

    Usage

    1. If you want to create documentations with sample files, you can use commands below.
    $ npm install
    $ grunt demo
    
    1. You can see any output related jsdoc process with a --debug flag.
    $ grunt demo --debug
    
    1. 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

    Keywords

    none

    Install

    npm i jsdoc-sable

    DownloadsWeekly Downloads

    2

    Version

    0.0.2

    License

    none

    Last publish

    Collaborators

    • frostbane