Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@gulp-utils/gulp-core-build-api-documenter

tnc199712MIT1.0.0TypeScript support: included

Gulp Core Build API Documenter

readme

@gulp-utils/gulp-core-build-api-documenter

gulp-core-build-api-documenter is a gulp-core-build subtask which introduces the ability to generate documentation, using api-documenter.

npm version Dependencies

Tasks

ApiDocumenterTask

Description

This task invokes api-documenter on a package.

Usage

const {apiDocumenter} = require("@gulp-utils/gulp-core-build-api-documenter");
const {initialize, parallel, serial, task} = require("@microsoft/gulp-core-build");
const {tscCmd, tslintCmd, apiExtractor} = require("@microsoft/gulp-core-build-typescript");

apiDocumenter.setConfig({
  format: "markdown"
});

task("default", serial(parallel(tscCmd, tslintCmd), apiExtractor, apiDocumenter));

initialize(require("gulp"));

Config

interface IApiDocumenterTaskConfig {
  format?: Format;
  inputFolder?: string;
  outputFolder?: string;
}

type Format = 'markdown' | 'yaml';

changelog

Change Log - @gulp-utils/gulp-core-build-api-documenter

This log was last generated on Thu, 27 Jun 2019 20:35:45 GMT and should not be manually modified.

1.0.0

Thu, 27 Jun 2019 20:35:45 GMT

Breaking changes

  • Add the @gulp-utils/gulp-core-build-api-documenter package.