Skip to main content

A Streamlit component to display markdown, which supports table, code switch, LaTeX, mermaid, and more.

Project description

streamlit-markdown

react-markdown for streamlit webapp

  • streaming rendering of markdown text
  • support for latex math
  • support for mermaid diagrams
  • support for code highlighting
  • support for tables
  • support for images
  • support for links

Installation

pip install streamlit-markdown

Usage

from streamlit_markdown import st_markdown

markdown_text = "$ y = f(x)$"
st_markdown(markdown_text)

run example:

streamlit run example.py

img.png

Buiding from source

Prerequisites

  • nodejs >= 18.x
  • yarn >= 1.22.x
  • poetry >= 1.2.x
  • python >= 3.8.x

Building

./build.sh

Publishing

poetry publish

License

This project is licensed under the MIT License - see the LICENSE file for details

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

streamlit_markdown-1.0.0.tar.gz (35.2 kB view hashes)

Uploaded Source

Built Distribution

streamlit_markdown-1.0.0-py3-none-any.whl (3.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page