From 0d5720bf039007c96b7bad51cd7a22335a5b5c41 Mon Sep 17 00:00:00 2001 From: Ayush Gupta Date: Tue, 13 Mar 2018 20:42:40 +0530 Subject: 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 Reviewed-By: Vse Mozhet Byt Reviewed-By: Luigi Pinca Reviewed-By: Yuta Hiroto Reviewed-By: James M Snell Reviewed-By: Trivikram Kamat --- BUILDING.md | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'BUILDING.md') diff --git a/BUILDING.md b/BUILDING.md index 697d4bd63a..e3bd7a7e9d 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 -- cgit v1.2.3