Metadata-Version: 2.1
Name: streamlit-markdown
Version: 1.0.0
Summary: A Streamlit component to display markdown, which supports table, code switch, LaTeX, mermaid, and more.
License: MIT
Author: Xueyuan Lin
Author-email: linxy59@mail2.sysu.eud.cn
Requires-Python: >=3.8, !=2.7.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: streamlit (>=0.63)
Description-Content-Type: text/markdown

# streamlit-markdown
react-markdown for streamlit webapp

![](docs/head.png)

- [x] streaming rendering of markdown text
- [x] support for latex math
- [x] support for mermaid diagrams
- [x] support for code highlighting
- [x] support for tables
- [x] support for images
- [x] support for links

## Installation

```bash
pip install streamlit-markdown
```

## Usage

```python
from streamlit_markdown import st_markdown

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

run example:

```bash
streamlit run example.py
```

![img.png](docs/img.png)

## Buiding from source

### Prerequisites

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

### Building

```bash
./build.sh
```

### Publishing

```bash
poetry publish
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

