Commit c22ee3fcb526b67d269c5920b0a847e697c15b26

Authored by dlstatic
1 parent 93c87af0

Add docs into project.

Showing 2 changed files with 51 additions and 1 deletions

Too many changes to show.

To preserve performance only 2 of 8 files are displayed.

.gitignore
1 images/node_modules/ 1 images/node_modules/
2 node_modules 2 node_modules
  3 +*doc*
  4 +*.swp
  5 +*.swp~
Gruntfile.js
@@ -30,14 +30,61 @@ module.exports = function (grunt) { @@ -30,14 +30,61 @@ module.exports = function (grunt) {
30 livereload: true 30 livereload: true
31 } 31 }
32 } 32 }
  33 + },
  34 +
  35 + concat: {
  36 + dist: {
  37 + src: ['css/**/*.css'],
  38 + dest: 'css/build.dest.css'
  39 + }
  40 + },
  41 +
  42 + ui_docs: {
  43 + mydocs: {
  44 + title: 'css-docs', // documentation page title
  45 + docsPath: 'docs/styleguide/', // path where you want to generate the styleguide
  46 + docsAssetsPath: 'assets/', // relative to docsPath
  47 + docsUIDocsAssetsPath: 'css/', // relative to docsAssetsPath
  48 +
  49 + rawAssetsDir: 'css/', // path to the assets you want to document
  50 +
  51 + // js: {
  52 + // rawDir: 'js/', // relative to rawAssetsDir
  53 + // validExtensions: ['.js', '.coffe'],
  54 + // ignore: ['**/vendor/**', '**/vendor-setup/**']
  55 + // },
  56 + css: {
  57 + rawDir: 'css/', // relative to rawAssetsDir
  58 + validExtensions: ['css'],
  59 + // ['.scss', '.css', '.sass', '.styl', '.less'],
  60 + ignore: ['**/bourbon/**'],
  61 + builtFilePaths: ['css/build.dest.css'], // path to the generated sass file(s)
  62 + outputDir: './' // relative to rawAssetsDir
  63 + }
  64 + }
  65 + },
  66 +
  67 + apidoc: {
  68 + myapp: {
  69 + src: 'js/',
  70 + dest: 'docs/apiguide/',
  71 + options: {
  72 + debug: true,
  73 + includeFilters: [ ".*\\.js$" ],
  74 + excludeFilters: [ "node_modules/" ]
  75 + }
  76 + }
33 } 77 }
34 }); 78 });
35 79
36 grunt.loadNpmTasks( "grunt-contrib-less" ); 80 grunt.loadNpmTasks( "grunt-contrib-less" );
37 grunt.loadNpmTasks( "grunt-contrib-watch" ); 81 grunt.loadNpmTasks( "grunt-contrib-watch" );
  82 + grunt.loadNpmTasks( "grunt-contrib-concat" );
  83 + grunt.loadNpmTasks( "grunt-ui-docs" );
  84 + grunt.loadNpmTasks( "grunt-apidoc" );
38 // grunt.loadNpmTasks('grunt-spritesmith'); 85 // grunt.loadNpmTasks('grunt-spritesmith');
39 86
40 grunt.registerTask('default', [ 87 grunt.registerTask('default', [
41 - 'less', 'watch' 88 + 'less', 'concat', 'watch'
42 ]); 89 ]);
43 }; 90 };