grunt-betajs-docs-compile

grunt-betajs-docs-compile 0.0.19

Build BetaJS documentations based on JSDOC.

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-betajs-docs-compile --save-dev

Once the plugin has been installed, it may be enabled via the jsdoc plugin inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-jsdoc');

Basic Usage

        jsdoc : {
            dist : {
                src : sources,
                options : {
                    destination : '../',
                    template : 'node_modules/grunt-betajs-docs-compile',
                    configure : './jsdoc.conf.json',
                    tutorials : './tutorials'
                }
            }
        }

Additional configuration

Additional configuration can be done in the jsdoc.conf.json. It might looks like this:

{
    "tags": {
        "allowUnknownTags": true
    },
    "plugins": ["plugins/markdown"],
 
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false,
        "dateFormat": "ddd MMM Do YYYY",
        "outputSourceFiles": true,
        "outputSourcePath": true,
        "systemName": "FooBar",
        "footer": "",
        "copyright": "MIT License",
        "navType": "vertical",
        "theme": "cerulean",
        "linenums": true,
        "collapseSymbols": false,
        "inverseNav": true,
        "highlightTutorialCode": true,
        "protocol": "fred://"
    },
    "markdown": {
        "parser": "gfm",
        "hardwrap": true
    }
}

This is mostly preserved and copied from Ink-Docstrap. Additionally, you can use the following optional arguments:

{
    ...
    
    "templates": {
        ...
        
        "template": "my/local/template/directory",
        "emptyTutorials": false || true,
        "singleTutorials": false || true,
        "singleModules": false || true
    },
 
    ...
    
    "pages": {
    	"about": {
    		"title": "About",
    		"source": "./about.md"
    	}
    }
}

Links

Resource	URL
Homepage	http://betajs.com
Git	git://github.com/betajs/grunt-betajs-docs-compile.git
Repository	https://github.com/betajs/grunt-betajs-docs-compile
Blog	http://blog.betajs.com
Twitter	http://twitter.com/thebetajs

Compatability

Target	Versions
NodeJS	0.10 - Latest

Main Contributors

• Oliver Friedmann
• Victor Lingenthal

License

Apache-2.0

Credits

This software may include modified and unmodified portions of:

• Ink-Docstrap