diff options
| author | Ayush Gupta <AyushG3112@gmail.com> | 2018-03-13 18:12:40 +0300 |
|---|---|---|
| committer | Trivikram <16024985+trivikr@users.noreply.github.com> | 2018-03-26 08:56:38 +0300 |
| commit | 0d5720bf039007c96b7bad51cd7a22335a5b5c41 (patch) | |
| tree | 740d60331b4a1a30c9804362f4b110fc2fcd5781 /BUILDING.md | |
| parent | d49661bb80dd6d9c012dc718bcec45c89fe2e3e1 (diff) | |
doc: document `make docopen`
Documented `make docopen` as a way to read documentation in the browser.
PR-URL: https://github.com/nodejs/node/pull/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>
Diffstat (limited to 'BUILDING.md')
| -rw-r--r-- | BUILDING.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/BUILDING.md b/BUILDING.md index 697d4bd63aa..e3bd7a7e9db 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -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 |