Skip to content

fix: render User Guide link correctly inside HTML div block#177

Open
slegarraga wants to merge 1 commit intooceanbase:developfrom
slegarraga:fix/readme-markdown-link-in-html
Open

fix: render User Guide link correctly inside HTML div block#177
slegarraga wants to merge 1 commit intooceanbase:developfrom
slegarraga:fix/readme-markdown-link-in-html

Conversation

@slegarraga
Copy link

Summary

Fixes #138 — The "User Guide" markdown link inside the <div align="center"> block was not rendering as a clickable hyperlink because markdown syntax is not processed inside HTML block elements per the CommonMark specification.

Changes

Converted the markdown link to an HTML <a> tag in the integrations section:

- Please refer to the [User Guide](https://www.oceanbase.ai/docs/seekdb-overview/) for more details.
+ Please refer to the <a href="https://www.oceanbase.ai/docs/seekdb-overview/">User Guide</a> for more details.

The other "User Guide" link (line 263, inside a <details> block after a code fence closing) already renders correctly since it's outside the HTML block context.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@hnwyllmm
Copy link
Member

Hi @slegarraga. Thanks for your contribution, but please sign the CLA first.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Doc] Markdown link inside HTML <p> tag won't render properly

3 participants