Skip to content

Commit 3b2e6fa

Browse files
committed
Inter-link documentation better
1 parent ac5b041 commit 3b2e6fa

File tree

2 files changed

+921
-0
lines changed

2 files changed

+921
-0
lines changed

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,17 @@ sections of code it refers to in a GitHub repository.
3333
The [gulp-documentation](https://github.com/documentationjs/gulp-documentation) project
3434
lets you run `documentation` as a [Gulp](http://gulpjs.com/) build task.
3535

36+
## Documentation
37+
38+
* [Getting_Started](docs/GETTING_STARTED.md): start here
39+
* [Usage](docs/USAGE.md): how to use documentation.js
40+
* [Recipes](docs/RECIPES.md): tricks for writing effective JSDoc docs
41+
* [Node API](docs/NODE_API.md): documentation.js's self-generated documentation
42+
* [FAQ](docs/FAQ.md)
43+
44+
* [Theming HTML](docs/THEME_HTML.md): tips for theming documentation output in HTML
45+
* [See also](docs/SEE_ALSO.md): a list of projects similar to documentation.js
46+
3647
## User Guide
3748

3849
Globally install `documentation` using the [npm](https://www.npmjs.com/) package manager:

0 commit comments

Comments
 (0)