gulp-zlanddoc
Build markdown docs for files and folders.
The documentation for the plugin is created using gulp-zlanddoc.
Just take a look into gulpfile.js or continue reading Installation and Usage instructions.
Installation
npm install gulp-zlanddoc --save-dev
Usage for creating folder descriptions
This will append folder descripions to your readme files.
var gulp = ;var zlanddoc = ; gulp;
Usage for creating folder and file descriptions
This will append folder and file descriptions to your README.md files.
You should add a filedescription comment to each file:
/** * @filedescription Here comes he description * and some more */
var gulp = ;var zlanddoc = ; gulp;
Directories
lib
contains the markdox custom formatter and custom template
Files
gulpfile.js
Gulfile for running the zlanddoc gulp plugin
index.js
gulp-plugin
index_test.js
test of the gulp-plugin