Skip to content

doc: spruce up user journey to local docs browsing #34986

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
DerekNonGeneric wants to merge 5 commits into from
Closed

doc: spruce up user journey to local docs browsing #34986

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
94b75aa
doc: spruce up user journey to local docs browsing
DerekNonGeneric Aug 30, 2020
6add9cf
fixup! doc: spruce up user journey to local docs browsing
DerekNonGeneric Aug 31, 2020
0a97007
fixup! doc: spruce up user journey to local docs browsing
DerekNonGeneric Aug 31, 2020
15014aa
fixup! doc: spruce up user journey to local docs browsing
DerekNonGeneric Aug 31, 2020
515b05f
Update Makefile
DerekNonGeneric Sep 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fixup! doc: spruce up user journey to local docs browsing
  • Loading branch information
Derek Lewis committed Aug 31, 2020
commit 6add9cf7f0bdb5020e7719def62799a9257c88a2
13 changes: 7 additions & 6 deletions BUILDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,23 +433,24 @@ To read the man page:
man doc/node.1
```

If you prefer to read the full documentation in a browser, run the following
after `make doc` is finished:
If you prefer to read the full documentation in a browser, run the following.
Comment thread
DerekNonGeneric marked this conversation as resolved.
Resolved

```bash
make docserve
```

This will provide a URL to where you may browse the documentation locally.
This will build the docs, spin up a static file server, and provide a URL to
where you may browse the documentation locally.

If you prefer to read the documentation as a one-page version of all the
browsable HTML documents, run the following after `make doc` is finished:
If you're comfortable viewing the documentation using the program your operating
system has associated with the default web browser, run the following.
Comment thread
DerekNonGeneric marked this conversation as resolved.
Resolved

```bash
make docopen
```

This will open a browser with the documentation.
This will build the docs, spin up a static file server, and open a URL to a
one-page version of all the browsable HTML documents using the default browser.

To test if Node.js was built correctly:

Expand Down