Commit c3ecf05
doc: document make docopen
Documented `make docopen` as a way to read documentation in the browser.
PR-URL: #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>1 parent 8338700 commit c3ecf05
1 file changed
Lines changed: 9 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -205,6 +205,15 @@ To read the documentation: | |||
| 205 | 205 | $ man doc/node.1 | |
| 206 | 206 | ``` | |
| 207 | 207 | ||
| 208 | + If you prefer to read the documentation in a browser, | ||
| 209 | + run the following after `make doc` is finished: | ||
| 210 | + | ||
| 211 | + ```console | ||
| 212 | + $ make docopen | ||
| 213 | + ``` | ||
| 214 | + | ||
| 215 | + This will open a browser with the documentation. | ||
| 216 | + | ||
| 208 | 217 | To test if Node.js was built correctly: | |
| 209 | 218 | ||
| 210 | 219 | ```console | |
0 commit comments