Comments (6)
Sure, I'm updating this module to documentation v4 and updating the readme with a multi-file example.
from gulp-documentation.
It seems your documentation should be updated. When I use
gulp.task('documentation', function() {
gulp.src('app/js/**/*.js')
.pipe(gulpDocumentation({
format: 'html'
}))
.pipe(gulp.dest('docs/api'));
});
I get the following error:
[10:59:38] Error: invalid format given: valid options are html, md, remark, json
at module.exports (/…/…/Workspace/pm-wg-angular/node_modules/gulp-documentation/index.js:82:11)
…
from gulp-documentation.
And it works only, when the task returns the stream. Otherwise no output is generated ;(
from gulp-documentation.
Hi @rwam - the recent version bump to 3.0.0 included a breaking change, along with updated examples. To update to 3.0.0, your code would look like:
gulp.task('documentation', function() {
gulp.src('app/js/**/*.js')
.pipe(gulpDocumentation('html'))
.pipe(gulp.dest('docs/api'));
});
That that modified version out and let me know if it still doesn't work with the change.
from gulp-documentation.
Hi @tmcw – I use version 3.0.0 and yes I tried it as described. But it only write it on the output directory when I use a return statement:
gulp.task('documentation', function() {
return gulp.src('app/js/**/*.js')
.pipe(gulpDocumentation('html'))
.pipe(gulp.dest('docs/api'));
});
Ok I see the info on the 3.0.0 tag is actual, but it's a little weird ;) There is a missing character:
from gulp-documentation.
Thanks for spotting that! I've updated the code examples so they should be functional.
from gulp-documentation.
Related Issues (20)
- How might one go about configuring a project to automatically set the title? HOT 3
- The code generator has deoptimised the styling of "..." as it exceeds the max of "100KB" HOT 2
- Allow usage of custom instance of documentation.js HOT 1
- TypeError: Cannot read property 'forEach' of undefined HOT 17
- Ignores description
- Please add License file HOT 1
- Name inference repeatedly documents the same items HOT 8
- ES6 babel project: Cannot read property 'reduce' or 'forEach' of undefined HOT 2
- `polyglot` gives me a blank documentation HOT 6
- Pass config and theme options HOT 1
- An in-range update of vinyl is breaking the build 🚨 HOT 1
- An in-range update of lint-staged is breaking the build 🚨 HOT 14
- Project name and version not included in HTML output HOT 2
- An in-range update of husky is breaking the build 🚨
- An in-range update of standard-version is breaking the build 🚨 HOT 2
- An in-range update of prettier is breaking the build 🚨 HOT 24
- An in-range update of concat-stream is breaking the build 🚨 HOT 1
- Version 10 of node.js has been released
- options do not seem to be working HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from gulp-documentation.