Skip to content
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

Jump to bottom

doc: fix links to ECMAScript module resolution #52883

Closed
wants to merge 3 commits into from
Closed

doc: fix links to ECMAScript module resolution #52883

wants to merge 3 commits into from

Commits on May 9, 2024

  1. doc: mention quicker way to build docs 

    `make doc-only` skips the process of building Node, which speeds
things up considerably for new contributors.
    @crawford
    crawford committed May 9, 2024
    Configuration menu
    Copy the full SHA
    c375cf0 View commit details
    Browse the repository at this point in the history

  2. tools: support rewriting links in code blocks 

    Within the API documentation for modules, there is a section of
pseudo-code which contains links to another file. This pseudo-code is
inside of a pre-formatted element (`<pre>`), but that prevents the
build process from rewriting those links from the Markdown source to
their corresponding HTML output.

This addresses that by adding a new language, "pre", whose output
remains unformatted but allows code fences to be annotated with
metadata - code fences must have a language before the metadata. When
the right metadata ("html") is present, it indicates that the code
block should be processed so that anchor tags are rewritten just like
other references.

The actual change to the documentation will happen in a later commit.
    @crawford
    crawford committed May 9, 2024
    Configuration menu
    Copy the full SHA
    490b02a View commit details
    Browse the repository at this point in the history

  3. doc: fix links to ECMAScript module resolution 

    The heading in esm.md was changed from "Resolver Algorithm
Specification" to "Resolution Algorithm Specification" back in
ccada8b. This also makes use of the changes in the previous commit to
rewrite the links to point to the generated HTML.
    @crawford
    crawford committed May 9, 2024
    Configuration menu
    Copy the full SHA
    f125d7c View commit details
    Browse the repository at this point in the history