Markdown

Markdown allows you to render Markdown content in your application with support for basic formatting, lists, links, and more.

The Markdown component renders content written in the Markdown syntax as HTML. It supports basic text formatting, lists, links, and more. All content provided to the component is internally sanitized to prevent potentially dangerous HTML from being rendered.

For more information about common Markdown syntax features, see the Markdown Guide.

Open in a
new tab

String markdownText = """
        ## Rich Text Formatting

        You can create **bold text**, *italicized text*, and `inline code` with simple Markdown syntax.
        You can also ~~strike through~~ text when needed.

        ## Lists

        ### Ordered List:
        1. First item
        2. Second item
        3. Third item with **bold text**

        ### Unordered List:
        - Fruits
            - Apples 🍎
            - Bananas 🍌
            - Oranges 🍊
        - Vegetables
            - Carrots
            - Broccoli

        ## Links & Quotes

        > Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents.

        [Visit Vaadin website](https://vaadin.com) | [Learn more about Markdown](https://www.markdownguide.org/)
        """;

Markdown markdown = new Markdown(markdownText);
add(markdown);

77B51D28-FE42-4829-A315-D0F3C8A55BED

Docs

Docs

Markdown