Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added gulp docs:generate task, pipes js through ngDocs and outputs do…
…cumentation and view app to /docs
- Loading branch information
Showing
7 changed files
with
30 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,3 +4,7 @@ dist | |
.tmp | ||
.sass-cache | ||
wallaby.conf.js | ||
docs/* | ||
!docs/img/ | ||
!.gitkeep | ||
|
Empty file.
Empty file.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
'use strict'; | ||
|
||
var gulp = require('gulp'); | ||
var gulpDocs = require('gulp-ngdocs'); | ||
|
||
gulp.task('docs:generate', [], function () { | ||
var options = { | ||
scripts: [ | ||
'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.2.28/angular.min.js', | ||
'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.2.28/angular-animate.min.js' | ||
], | ||
html5Mode: false, | ||
startPage: '/docs', | ||
title: "CIViC Client Developer Documentation", | ||
image: "CIViC_logo_sm.png", | ||
imageLink: "http://civicdb.org", | ||
titleLink: "/docs", | ||
discussions: true | ||
}; | ||
|
||
return gulp.src('src/{app,components}/**/*.js') | ||
.pipe(gulpDocs.process(options)) | ||
.pipe(gulp.dest('./docs')); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters