Easy get starting generation document with Dgeni.
Dgeni is document generator of ngdoc. There are other document generator corresponding to ngdoc but, Dgeni is better than others in terms and many of the types that can be specified inngdoc, that the height of scalability.
However, I easy get starting with Dgeni. because it cannot be used only by the installation. and no information.
Therefore, I get started for easily with Dgeni. because, it is since it cannot be used only by installation but there is no information on Dgeni.
Installation
npm install --save-dev grunt grunt-dgeni
To allow the execution of Dgeni in GruntJS via grunt-dgeni and then install.
Setting
grunt.initConfig({ dgeni: { options: { // Base directory of the JavaScript file to be read basePath: '/path/to' }, // JavaScript file to be read src: ['src/*.js'], // Directory to output the document dest: '/path/to/build' }, }); grunt.loadNpmTasks('grunt-dgeni');
Above/path/to/src/Set the document from JavaScript file directly under /path/to/build you will write a Gruntfile.js when outputting to.
As a side note src If you want to specify, options.basePath becomes mandatory. If the module name is omitted in the doc comments in the specification of Dgeni, this options.basePath or, is to recognize the module name of the directory immediately below. Please check the issue of the following for more information.
Module name becomes two names · Issue # 105 · angular / dgeni
Run
grunt dgeni
Document After finishing the setting, and you run the above command dest will be output to the directory specified in the.
In the package by default dgeni-markdown will be used. If you want to use other packages, use the package of its own
dgeni: { options: { packages: [ 'PackageName', '/path/to/ config' ] },
},
As options.packages Please use.
Summary
Would How was. It is now easily handle the document generator par corresponding to ngdoc other Dgeni. Perhaps the favorite to produce the document in AngularJS applications in the future because it is likely to Dgeni, I am happy and enjoy everyone started to touch this opportunity.
