Skip to content
Permalink
Browse files
added notes on adding API documentation
  • Loading branch information
aa7401 committed Jun 22, 2017
1 parent 2fcc2f5 commit 7316e4e36d99957b177c1d8167bacdec54d62dc1
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 0 deletions.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
@@ -355,7 +355,22 @@ Add inline annotations to source code

npm module apidoc generates the documentation

Example:

```
$ node_modules/.bin/apidoc -e node_modules/ -o docs/api/
```
This generates the API documentation and creates the web page in the `docs/api/` directory. files in the `docs/` directory can be published as a website by **GitHub**. To enable this you should generate the documentation as shown, commit and push the files to GitHub then edit the repository settings and enable **GitHub Pages** as shown.

![GitHub Pages settings](.images/github_pages_settings.png)

This will display a link to the root of the GitHub pages.

![GitHub Pages URL](.images/github_pages_url.png)

Click on this and you get a _page not found_ error. Append `api/` to this url and refresh the page to see the documentation.

![API Documentation](.images/api_documentation.png)

### URLs

0 comments on commit 7316e4e

Please sign in to comment.