Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including webpack-angular-dgeni-plugin with all npm packages installed. Try it out:

var webpackAngularDgeniPlugin = require("webpack-angular-dgeni-plugin")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

webpack-angular-dgeni-plugin v0.0.1

Webpack plugin for generating angular documentation with Dgeni

webpack-angular-dgeni-plugin

Webpack plugin for generate dgeni angular documentation with default template

Angular documentation is generated with DGeni

Please refer to Angular documentation for doc's comments generation.

Installation

npm install webpack-angular-dgeni-plugin

Configuration

Webpack plugin definition :

new DocsGeneratorPlugin({
    enable       : true,
    staticContent: './docs',
    sources      : {
      include : 'src/app/**/**/*.js',
      basePath: 'src/app'
    },
    output       : 'dist-docs'
})
  • enable allow you to disable docs generation with variable
  • staticContent contain ngdoc static file (markdown type). You can find example under static-example
  • sources describe all folder to be scan
    • include source glob pattern
    • basePath root path for source pattern
  • output output directory

ChangeLog

###v0.0.1

  • Add Webpack plugin structure
  • Add Dgeni processor
  • Add Dgeni templates

License

MIT License

Copyright (c) 2016 Groupe SII

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free