Skip to content
This repository was archived by the owner on Mar 13, 2025. It is now read-only.
This repository was archived by the owner on Mar 13, 2025. It is now read-only.

Markdown Links Not Rendering Inside <details> #65

Open
@Basit-Balogun10

Description

@Basit-Balogun10

Description

Markdown links inside <details> do not render properly when placed immediately after <summary>. This happens because some Markdown parsers require a newline after <summary> for proper processing.

Steps to Reproduce

  1. Add a Markdown link inside <details> like this:
    <details>
      <summary>Example</summary>
      Check out [this link](https://example.com).
    </details>
  2. The link does not render correctly in some environments. In this case, it looks like this in our Create your first project in Lightdash docs

Image

Expected Behavior

The Markdown link should render properly inside <details>.

Workaround

Adding a newline after <summary> can sometimes fix this, but it's fragile as it can be easily removed or refactored out.

Proposed Solution

Use an HTML <a> tag instead of Markdown links:

<a href="https://example.com">this link</a>

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions