Skip to content

Commit 5e9f929

Browse files
AyushG3112targos
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 6ead99a commit 5e9f929

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
@@ -206,6 +206,15 @@ To read the documentation:
206206
$ man doc/node.1
207207
```
208208

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

211220
```console

0 commit comments

Comments
 (0)