Comments (5)
Found a way now, but it's nasty:
gulp.task("docs", function(){
var src = 'docstarget/**/*.js';
return gulp.src(src)
.pipe(tap(function(file){
fs.createReadStream(file.path)
.pipe(jsdoc2md.render())
.pipe(fs.createWriteStream(file.path.replace(/.js/g,'.md')));
}))
.on("error", function(err){
gutil.log(gutil.colors.red("jsdoc2md failed"), err.message);
});
});
from jsdoc-to-markdown.
hi, will look into this when i get a moment but i notice you're missing a return statement..
in the example here notice it is return jsdoc2md.render(src, options)
- your code above lacks the return
.. does adding it help in your case?
from jsdoc-to-markdown.
No, that does not help :/
from jsdoc-to-markdown.
hi! You should no longer need this hack, or the custom gulp task.. the latest plug-in version should just work, meaning you can use this method to get "one markdown out per js in".. make sure you adhere to the caveat mentioned on the plugin docs.. let me know how it goes..
from jsdoc-to-markdown.
inactive, assuming resolved..
from jsdoc-to-markdown.
Related Issues (20)
- Decorated classes get named "_class" in output .md file HOT 2
- Support for TypeScript types inside JsDoc? HOT 5
- This experimental syntax requires enabling the parser plugin: "importAssertions" HOT 10
- How to group ES2015 modules? HOT 3
- Option to specify which jsdoc binary should be used HOT 5
- Is there any fix for the TYPESCRIPT Comments that aren't shown?
- command-line option "template" requires a value. HOT 7
- can't parse typescript file content with Node.js api getTemplateData HOT 1
- Missing documentation for classes with constructors HOT 2
- The "โ" character becomes "รรงร"
- Ignoring instance method parent name? HOT 1
- [feature request] Support optional instantiate parent name prefix
- can system helpers be overridden? HOT 1
- FEAT: Include filename for each function in Markdown
- Doc not generate and no error message HOT 2
- Security Issue and Deprecation Warning in jsdoc-parse due to lodash.pick HOT 2
- Required and optional parameters are not distinguished. HOT 2
- markdown-it < 13.0.2 security vulnerability HOT 1
- Error: The partial main could not be found HOT 7
- Add `--clever-links` and `--monospace-links` options 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 jsdoc-to-markdown.