Skip to content

chaordic-yuidoc-theme 0.0.3-rc.0

Install from the command line:
Learn more about npm packages
$ npm install @chaordic/chaordic-yuidoc-theme@0.0.3-rc.0
Install via package.json:
"@chaordic/chaordic-yuidoc-theme": "0.0.3-rc.0"

About this version

chaordic-yuidoc-theme

Chaordic's yuidoc theme =]

Add grunt-contrib-yuidoc and chaordic-yuidoc-theme to your package.json project.

{
  "name": "awesome-project",
  "description": "My awesome project",
  "version": "v1.0.0",
  "dependencies": {},
  "devDependencies": {
    "grunt": "0.4.1",
    "grunt-contrib-yuidoc": "~0.4.0",
    "chaordic-yuidoc-theme": "git://github.com/chaordic/chaordic-yuidoc-theme.git"
  }
}

Configure your GruntFile.js to use the theme within node_modules directory.

module.exports = function(grunt) {

    grunt.initConfig({
        pkg: grunt.file.readJSON('package.json'),

        yuidoc : {
            compile : {
                name : "<%= pkg.name %>",
                description : "<%= pkg.description %>",
                version : "<%= pkg.version %>",
                url : "<%= pkg.homepage %>",
                options : {
                    paths : ["lib/"],
                    outdir : "docs/",
                    themedir: "node_modules/chaordic-yuidoc-theme"
                }
            }
        }
    });
        
        
    // 3rd party tasks
    grunt.loadNpmTasks("grunt-contrib-yuidoc");
    
};

Run grunt yuidoc.

# grunt yuidoc

Enjoy.

Details


Assets

  • chaordic-yuidoc-theme-0.0.3-rc.0-npm.tgz

Download activity

  • Total downloads 437
  • Last 30 days 3
  • Last week 0
  • Today 0

Recent versions

View all