Skip to content

Commit

Permalink
doc: Added python SimpleHTTPServer as a method reading docs in browser
Browse files Browse the repository at this point in the history
Documented an easier way for users to browse documentation without
setting up a whole web environment. It make the process of reading the
latest documentation, and comparing it with the documentation of
older versions on the Node.JS website a lot easier.
  • Loading branch information
AyushG3112 committed Mar 26, 2018
1 parent c355442 commit 0770c1f
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,14 +206,15 @@ To read the documentation:
$ man doc/node.1
```

If you prefer to read the documentation in the browser,
run the following once `make doc` is done:
If you prefer to read the documentation in the browser and have `python`
installed, you can run:

```console
$ make docopen
$ cd out/doc/api/
$ python -m SimpleHTTPServer
```

This will open up a browser tab/window with the documentation.
and navigate to `http://localhost:8000` in your browser.

To test if Node.js was built correctly:

Expand Down

0 comments on commit 0770c1f

Please sign in to comment.