webpack-angular-dgeni-plugin
v0.0.1
Published
Webpack plugin for generating angular documentation with Dgeni
Downloads
44
Readme
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 variablestaticContent
contain ngdoc static file (markdown type). You can find example understatic-example
sources
describe all folder to be scaninclude
source glob patternbasePath
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