GithubHelp home page GithubHelp logo

Comments (5)

phun-ky avatar phun-ky commented on August 31, 2024

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.

75lb avatar 75lb commented on August 31, 2024

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.

phun-ky avatar phun-ky commented on August 31, 2024

No, that does not help :/

from jsdoc-to-markdown.

75lb avatar 75lb commented on August 31, 2024

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.

75lb avatar 75lb commented on August 31, 2024

inactive, assuming resolved..

from jsdoc-to-markdown.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.