Nonstop Progressive Marxism

    gulp-yuidoc

    0.1.2 • Public • Published

    gulp-yuidoc

    NPM version]npm-url Build Status Coverage Status Dependency Status Code Climate

    yuidoc plugin for gulp

    WARNING

    This is an early release, and you will likely encounter bugs or limitations.

    TL;DR

    Install gulp-yuidoc as a development dependency:

    npm install --save-dev gulp-yuidoc

    Then, add it to your gulpfile.js:

    var yuidoc = require("gulp-yuidoc");
     
    gulp.src("./src/*.js")
      .pipe(yuidoc())
      .pipe(gulp.dest("./doc"));

    API

    yuidoc.parser(options, name)

    Calling the parser alone will build a vinyl containing the parsing result of fed files. By default, that vinyl will get named "yuidoc.json", unless you override it with the optional "name" argument.

    "options" allows you to speficy yuidoc parsing options (XXX untested).

    gulp.src("./src/*.js")
      .pipe(yuidoc.parser())
      .pipe(gulp.dest("./jsondocoutput"));

    yuidoc.reporter()

    Reports whatever went wrong with parsing.

    gulp.src("./src/*.js")
      .pipe(yuidoc.parser())
      .pipe(yuidoc.reporter())

    If you prefer ugly things, call yiudoc.yuiReporter() instead (default reporter, which is beautiful, is "stylish", stolen from sindresorhus).

    yuidoc.generator(options)

    Generates documentation from the result of the parser.

    gulp.src("./src/*.js")
      .pipe(yuidoc.parser())
      .pipe(yuidoc.generator())
      .pipe(gulp.dest('./documentation-output'))

    You may pass yuidoc generator options optionally (XXX untested - undocumented).

    yuidoc(parseOpts, renderOpts)

    This:

    gulp.src("./src/*.js")
      .pipe(yuidoc())
      .pipe(gulp.dest('./documentation-output'))

    is a shortcut for:

    gulp.src("./src/*.js")
      .pipe(yuidoc.parser())
      .pipe(yuidoc.reporter())
      .pipe(yuidoc.generator())
      .pipe(gulp.dest('./documentation-output'))

    License

    MIT License

    Install

    npm i gulp-yuidoc

    DownloadsWeekly Downloads

    181

    Version

    0.1.2

    License

    MIT

    Last publish

    Collaborators

    • dmp