Skip to content

Commit c3ecf05

Browse files
AyushG3112BethGriggs
authored andcommitted
doc: document make docopen
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]>
1 parent 8338700 commit c3ecf05

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

BUILDING.md

+9
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,15 @@ To read the documentation:
205205
$ man doc/node.1
206206
```
207207

208+
If you prefer to read the documentation in a browser,
209+
run the following after `make doc` is finished:
210+
211+
```console
212+
$ make docopen
213+
```
214+
215+
This will open a browser with the documentation.
216+
208217
To test if Node.js was built correctly:
209218

210219
```console

0 commit comments

Comments
 (0)