yuidoc-marviq-theme

0.1.5 • Public • Published

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" ]
        }
    }
}

/yuidoc-marviq-theme/

    Package Sidebar

    Install

    npm i yuidoc-marviq-theme

    Weekly Downloads

    24

    Version

    0.1.5

    License

    none

    Last publish

    Collaborators

    • rdewit