A package to generate ngdocs using Dgeni similar to whats currently used on AngularJS website.
npm install suh-dgeni-docs --save-dev
Clone GitHub Reposotiry
git clone https://github.com/suhdev/suh-dgeni-ngdocs
First, install the
canonical-path module using NPM, the module is used to generate absolute paths for your source files:
npm install canonical-path --save-dev
var path =fs =ngdocs = ;ngdocs;
The same code can be used within a gulp task as follows:
var gulp = ;//assuming there is a task (```concat-js```) to concatenate the sourcegulp;
@todo The tag now supports a type it can be used in the following syntax:/*** @ngdoc module* @name BlahBlah* @module BlahBlah* @todo* @todo* @todo* @todo* @description* this is just a description*/
Also, note that the todo will be grouped by their type and then presented.
If no type is provided it will default to a
@todo todo text
@note The tag now supports a type as in the following syntax:/*** @ngdoc module* @name BlahBlah* @module BlahBlah* @note* @note* @note* @note* @description* this is just a description*/
@briefdesc This tag allows for adding a special description to show up on summary pages rather than using the first paragraph of the description tag./*** @ngdoc module* @name BlahBlah* @module BlahBlah* @todo* @todo* @todo* @todo* @description* this is just a description*/
This package is basically an extension to the
dgeni-packages module (built on top of it),in which I replaced the templates with customized ones,
I've also included some extra tags and extended some of the previously defined ones.
A full list of the tags will be added here as well as in the documentation (as soon as I finish writing them).
So, this is to thank everyone who contributed to the
dgeni-packages, which can be accessed on dgeni-packages, reading through that code was quiet amusing, and I loved the architecture of the module. It does lack documentation, but the code is almost self explanatory.
I would also like to thank the guys behind UIKit, which can be accessed on UIKit, as I've used their framework to in the templates (because I suck at design), and I just fall in love with their framework.
I'm currently working on lots of additions and fixing, however, the base code will not change, and thus the module is ready for usage now, anything else will either be a bug fix or an extension that should be backward compatible. Some of these are:
- Using own templates.
- Smarter linkage with github and git repository.
- Lots of minor bug fixes that I've already noted down.
I'm compiling a list of the upcoming additions and I'll add them all here as soon as I have a my roadmap ready. Some of these are: