Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

idanbauer/ngdocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

5 Commits

Repository files navigation

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

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

AltStyle によって変換されたページ (->オリジナル) /