clenemt / docdash

:zap: Lodash inspired JSDoc 3 template/theme
http://clenemt.github.io/docdash/
Other
824 stars 201 forks source link

no extra files (css and more) generated #24

Closed jgoknowis closed 7 years ago

jgoknowis commented 7 years ago

conf.json:

{
    "tags": {
        "allowUnknownTags": true,
        "dictionaries": ["jsdoc", "closure"]
    },
    "opts": {
        "template": "node_modules/docdash",
        "destination": "./gen-jsdoc"
    },
    "plugins": ["plugins/markdown"],
    "templates": {
        "___options-doku:": "https://github.com/docstrap/docstrap#options",
        "includeDate": "true",
        "navType": "vertical",
        "theme": "lumen",
        "linenums": "true",
        "collapseSymbols": "true",
        "outputSourceFiles": "false",
        "outputSourcePath": "false",
        "dateFormat": "YYYY-MM-DD",
        "search": "true",
        "cleverLinks": true,
        "monospaceLinks": true
    }
}

gulp snippet:

gulp.task('generate-jsdoc', function(cb) {
    var config = require('./src/main/resources/template/conf.json');
    gulp.src([ './target/*.js' ], {
        read : false
    }).pipe($.jsdoc3(config, cb));
});

result:

│   DataObjectUtils-x.x.x-SNAPSHOT.js.html
│   global.html
│   index.html
│   ISI.html
│   namespaces.list.html
│   quicksearch.html
│
├───fonts
├───img
├───scripts
└───styles