Skip to content

doc: fix links to ECMAScript module resolution #52883

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
crawford wants to merge 3 commits into from
Closed

doc: fix links to ECMAScript module resolution #52883

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c375cf0
doc: mention quicker way to build docs
crawford May 7, 2024
490b02a
tools: support rewriting links in code blocks
crawford May 7, 2024
f125d7c
doc: fix links to ECMAScript module resolution
crawford May 7, 2024
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
Next Next commit
doc: mention quicker way to build docs 
`make doc-only` skips the process of building Node, which speeds
things up considerably for new contributors.
  • Loading branch information
@crawford
crawford committed May 9, 2024
commit c375cf0f00bf1f9d483dd8fe7a676026b05a0d20
7 changes: 4 additions & 3 deletions doc/contributing/api-documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down Expand Up @@ -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