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.

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

chore: update markdown formatting inside <Tip> #3126

Merged
merged 2 commits into from
Jan 16, 2025

Conversation

ruijdacd
Copy link
Contributor

@ruijdacd ruijdacd commented Jan 7, 2025

Markdown formatting isn't working well inside the <Tip> element.

This might be affecting other pages as well, but this is the one I came across.

Markdown formatting isn't working well inside the `<Tip>` element.
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@lhoestq
Copy link
Member

lhoestq commented Jan 13, 2025

it doesn't seem to work well either with your change https://moon-ci-docs.huggingface.co/docs/dataset-viewer/pr_3126/en/postgresql

Maybe simply remove the and keep it as plain text

@ruijdacd
Copy link
Contributor Author

That's a shame, I'll make that change now

Markdown formatting is not working as expected inside of the `<Tip>` component
Copy link
Member

@lhoestq lhoestq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks !

@lhoestq lhoestq merged commit e8ff010 into huggingface:main Jan 16, 2025
1 check failed
@ruijdacd
Copy link
Contributor Author

I've just thought that we could've just replaced the markdown elements with HTML and the formatting would be correct inside of the Tip component.

Would you like me to submit that change?

@lhoestq
Copy link
Member

lhoestq commented Jan 16, 2025

I haven't tried that, not sure if it works. No strong opinion though

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.

3 participants