a way to document Angular Projects
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
img
src
.gitignore
.jshintrc
README.md
angular-docs.iml
docsConfig.json
package.json

README.md

ngdocs

A way to document Angular Projects

To get started, create a docsConfig.json file in your project root directory with the following content :

{ 
	"outputDir": "path/to/output",
	"contentDir": "path/to/guidesandcontents",
	"apiDir": "path/to/projectcode",
	"logoFile": "img/logo.png"
}
  1. Make sure you have Node.js installed.
  2. Run npm install ngdocs -g to create the ngdocs package.
  3. Run ngdocs from your project root folder.

See https://github.com/idanush/ngdocs/wiki/API-Docs-Syntax for documenting your code.