0.1.5 • Published 10 years ago

yuidoc-marviq-theme v0.1.5

Weekly downloads
10
License
-
Repository
-
Last release
10 years ago

yuidoc-marviq-theme

A revamped YuiDoc theme in Marviq style using bootstrap.

If your using it in combination with Grunt, which you probably will want to do. You have to set the following options in your gruntfile for yuidoc:

themedir - Location to the theme folder

helpers - Location to the helpers file in the themedir ( themefolder/helpers/helpers.js)

Example to setup using Grunt:

yuidoc: {
    compile: {
        name: '<%= pkg.name %>',
        description: '<%= pkg.description %>',
        version: '<%= pkg.version %>',
        url: '<%= pkg.homepage %>',
        options: {
            paths: 'src',
            outdir: 'docs',
            themedir: 'yuidoc-marviq-theme',
            exclude: '',
            syntaxtype: "jsAndCoffee",
            extension: ".coffee,.js",
            helpers: [ "yuidoc-marviq-theme/helpers/helpers.js" ]
        }
    }
}
0.1.5

10 years ago