Markdown

The rx.markdown component can be used to render markdown text. It is based on Github Flavored Markdown.

Hello World!

Support us on Github.

Use reflex deploy to deploy your app with a single command.

Math Equations

You can render math equations using LaTeX. For inline equations, surround the equation with $:

Pythagorean theorem: $a^2 + b^2 = c^2$ .

Syntax Highlighting

You can render code blocks with syntax highlighting using the ```{language} syntax:

import reflex as rx
from .pages import index

app = rx.App()
app.add_page(index)

Tables

You can render tables using the | syntax:

Syntax	Description
Header	Title
Paragraph	Text

Plugins

Plugins can be used to extend the functionality of the markdown renderer.

By default Reflex uses the following plugins:

remark-gfm for Github Flavored Markdown support (use_gfm).
remark-math and rehype-katex for math equation support (use_math, use_katex).
rehype-unwrap-images to remove paragraph tags around images (use_unwrap_images).
rehype-raw to render raw HTML in markdown (use_raw). NOTE: in a future release this will be disabled by default for security reasons.

These default plugins can be disabled by passing use_[plugin_name]=False to the rx.markdown component. For example, to disable raw HTML rendering, use rx.markdown(..., use_raw=False).

Arbitrary Plugins

You can also add arbitrary remark or rehype plugins using the remark_plugins and rehype_plugins props in conjunction with the rx.markdown.plugin helper.

rx.markdown.plugin takes two arguments:

The npm package name and version of the plugin (e.g. remark-emoji@5.0.2).
The named export to use from the plugin (e.g. remarkEmoji).

Remark Plugin Example

For example, to add support for emojis using the remark-emoji plugin:

Hello 😄! 🚀 🎉

Rehype Plugin Example

To make rehype-raw safer for untrusted HTML input we can use rehype-sanitize, which defaults to a safe schema similar to that used by Github.

Here is some bold text and a .

Plugin Options

Both remark_plugins and rehype_plugins accept a heterogeneous list of plugin or tuple of (plugin, options) in case the plugin requires some kind of special configuration.

For example, rehype-slug is a simple plugin that adds ID attributes to the headings, but the rehype-autolink-headings plugin accepts options to specify how to render the links to those anchors.

Heading 1

Heading 2

Component Map

You can specify which components to use for rendering markdown elements using the component_map prop.

Each key in the component_map prop is a markdown element, and the value is a function that takes the text of the element as input and returns a Reflex component.

Hello World!

This is a Subheader

And Another Subheader

Here is some code:

import reflex as rx

component = rx.text("Hello World!")

And then some more text here, followed by a link to Reflex.

API Reference

rx.markdown

A markdown component, with optional div-wrapping when style props are given.

Props

No component specific props

Event Triggers

See the full list of default event triggers