Skip to content
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 opened this issue Mar 10, 2025 · 0 comments · May be fixed by #66
Open

Markdown Links Not Rendering Inside <details> #65

Basit-Balogun10 opened this issue Mar 10, 2025 · 0 comments · May be fixed by #66

Comments

@Basit-Balogun10
Copy link

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>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant