Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
img
 
 
src
 
 
 
 
 
 
 
 
 
 

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.

About

a way to document Angular Projects

Resources

Releases

No releases published

Packages

No packages published
You can’t perform that action at this time.