| Function signature[source] | |
|---|---|
st.markdown(body, unsafe_allow_html=False, *, help=None) | |
| Parameters | |
body (str) | The string to display as Github-flavored Markdown. Syntax information can be found at: https://github.github.com/gfm. This also supports:
|
unsafe_allow_html (bool) | By default, any HTML tags found in the body will be escaped and therefore treated as pure text. This behavior may be turned off by setting this argument to True. That said, we strongly advise against it. It is hard to write secure HTML, so by using this argument you may be compromising your users' security. For more information, see: |
help (str) | An optional tooltip that gets displayed next to the Markdown. |
Examples
import streamlit as st
st.markdown("*Streamlit* is **really** ***cool***.")
st.markdown('''
:red[Streamlit] :orange[can] :green[write] :blue[text] :violet[in]
:gray[pretty] :rainbow[colors].''')
st.markdown("Here's a bouquet —\
:tulip::cherry_blossom::rose::hibiscus::sunflower::blossom:")
multi = '''If you end a line with two spaces,
a soft return is used for the next line.
Two (or more) newline characters in a row will result in a hard return.
'''
st.markdown(multi)
import streamlit as st
md = st.text_area('Type in your markdown string (without outer quotes)',
"Happy Streamlit-ing! :balloon:")
st.code(f"""
import streamlit as st
st.markdown('''{md}''')
""")
st.markdown(md)
Still have questions?
Our forums are full of helpful information and Streamlit experts.