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 <anna@addaleax.net>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
  • Loading branch information
AyushG3112 authored and BethGriggs committed Dec 4, 2018
1 parent 8338700 commit c3ecf05
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 @@ -205,6 +205,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 c3ecf05

Please sign in to comment.