Skip to content

sukharenko/sails-apidocs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sails-apidocs

Automatically generate documentation for a Sails.js API from Sails blueprints and inline code documentation

Manual Install

npm install sails-apidocs

Automatic Install

Edit file package.json:

"dependencies": {
...
	"sails-apidocs": ">= 0.0.3"
...
}

Then run:

npm install

Usage

From project root run:

node node_modules/sails-apidocs/gendocs.js

Output

Open assets/docs/index.html in browser

About

Automatically generate documentation for a Sails.js API from Sails blueprints and inline code documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • JavaScript 54.1%
  • HTML 45.9%