Skip to content

docs: add markdown documentation #4314

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

Open
wants to merge 1 commit into
base: latest
Choose a base branch
from
Open

docs: add markdown documentation #4314

wants to merge 1 commit into from

Conversation

tomivirkki
Copy link
Member

Add documentation page for the Markdown component

Related to vaadin/platform#7580

@tomivirkki tomivirkki requested a review from rolfsmeds May 15, 2025 12:31
Copy link

AI Language Review

"""]

= [since:com.vaadin:[email protected]]#Markdown#

// tag::description[]
Markdown component allows the user to display formatted text content using the Markdown syntax.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Markdown component allows the user to display formatted text content using the Markdown syntax.
The Markdown component renders content written in the Markdown syntax as HTML.

Copy link
Contributor

Choose a reason for hiding this comment

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

The gray background in the thumbnail could be changed to the bg color used in other thumbnails: #F0F5F7.

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.

2 participants