daohualiuxiang
/
node
mirror of https://github.com/nodejs/node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: mention quicker way to build docs 

`make doc-only` skips the process of building Node, which speeds
things up considerably for new contributors.

PR-URL: https://github.com/nodejs/node/pull/52937
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
pull/52971/head
Alex Crawford 2024-05-12 11:54:03 -07:00 committed by Michaël Zasso
parent ca5607bbc8
commit 9102255749
No known key found for this signature in database
GPG Key ID: 770F7A9A5AE15600
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/contributing/api-documentation.md
View File

@ -4,9 +4,8 @@ The Node.js API documentation is generated by an in-house tooling that resides
within the [tools/doc](https://github.com/nodejs/node/tree/main/tools/doc)
directory.
The build process (using `make doc`) uses this tooling to parse the markdown
files in [doc/api](https://github.com/nodejs/node/tree/main/doc/api) and
generate the following:
The build process (using `make doc` or `make doc-only`) uses this tooling to
parse the markdown files in [`doc/api/`][] and generate the following:
1. Human-readable HTML in `out/doc/api/*.html`
2. A JSON representation in `out/doc/api/*.json`
@ -302,3 +301,5 @@ mutate the data and appends it to the final JSON object.
For a more in-depth information we recommend to refer to the `json.mjs` file as
it contains a lot of comments.
[`doc/api/`]: https://github.com/nodejs/node/tree/main/doc/api