OSSForks/node
1
0
Fork 0
mirror of https://github.com/zebrajr/node.git synced 2025-12-06 00:20:08 +01:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

doc: document make docopen

Browse Source 
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>
This commit is contained in:
Ayush Gupta 2018-03-13 20:42:40 +05:30 committed by Michaël Zasso
parent 6ead99aa73
commit 5e9f9297b3
No known key found for this signature in database
GPG Key ID: 770F7A9A5AE15600
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
BUILDING.md
View File

@ -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