Skip to content

docs: <code> blocks in headings not rendered correctly #31451

Description

@GeoffreyBooth

See e.g. https://nodejs.org/api/esm.html#esm_package_json_type_field. The text "type" should be rendered as a code block, yet instead it’s rendered as normal text with wide margins on either side. In earlier versions I tried using backticks but they weren’t supported in Markdown headings.

cc @Trott

Activity

  1. added
    docIssues and PRs related to Node.js documentation.
    buildIssues and PRs related to Node.js builds or CI infrastructure.
    on Jan 21, 2020
  2. himself65 commented on Jan 22, 2020

    @himself65
    Member

    commit fdec6bd changed this style

    h1, h1 code,
    h2, h2 code,
    h3, h3 code,
    h4, h4 code,
    h5, h5 code,
    h6, h6 code {
    background-color: inherit;
    color: inherit;
    font-family: inherit;
    font-weight: 700;
    line-height: inherit;
    position: relative;
    margin: 1.5rem 0 1rem;
    padding: inherit;
    text-rendering: optimizeLegibility;
    }

  3. added a commit that references this issue on Jan 22, 2020
  4. Trott commented on Jan 22, 2020

    @Trott
    Member

    Hopeful fix in #31451.

    image of a cartoon character trying to adjust a window shade over and over, eventually destroying it, labeled "CSS"

  5. added a commit that references this issue on Jan 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    buildIssues and PRs related to Node.js builds or CI infrastructure.docIssues and PRs related to Node.js documentation.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions