Skip to content

Commit

Permalink
doc: document make docopen
Browse files Browse the repository at this point in the history
Documented `make docopen` as a way to read documentation in the browser.

PR-URL: #19321
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Yuta Hiroto <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
  • Loading branch information
AyushG3112 authored and targos committed Mar 27, 2018
1 parent 6ead99a commit 5e9f929
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,15 @@ To read the documentation:
$ man doc/node.1
```

If you prefer to read the documentation in a browser,
run the following after `make doc` is finished:

```console
$ make docopen
```

This will open a browser with the documentation.

To test if Node.js was built correctly:

```console
Expand Down

0 comments on commit 5e9f929

Please sign in to comment.