diff options
| author | Ayush Gupta <AyushG3112@gmail.com> | 2018-03-13 20:42:40 +0530 |
|---|---|---|
| committer | Beth Griggs <Bethany.Griggs@uk.ibm.com> | 2018-12-04 11:18:57 +0000 |
| commit | c3ecf05b018da2600d93dc9a4e674ad09ef8e289 (patch) | |
| tree | 2f5425c7083dd29e0b07d8964b48b2c9a017cecc | |
| parent | 8338700d05a911c0784e833381f1c727bed4f281 (diff) | |
| download | node-new-c3ecf05b018da2600d93dc9a4e674ad09ef8e289.tar.gz | |
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>
| -rw-r--r-- | BUILDING.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/BUILDING.md b/BUILDING.md index 3f95f32d72..08276975ae 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -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 |