> For the complete documentation index, see [llms.txt](https://developer.supervisely.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.supervisely.com/app-development/widgets/text-elements/markdown.md).
# Markdown
## Introduction
The `Markdown` widget allows you to easily add and style your text using Markdown syntax. By using Markdown, you can add headings, lists, links, images, and more to enhance the presentation of your text content.
## Function signature
```python
Markdown(
content="",
height=300,
widget_id=None,
)
```
## Parameters
| Parameters | Type | Description |
| :-----------: | :----------------------------------: | :------------------------------------: |
| `content` | `str` | `Markdown` content text |
| `height` | `Union[int, Literal["fit-content"]]` | `Widget` height |
| `show_border` | `bool` | Display border around Markdown content |
| `widget_id` | `str` | ID of the widget |
### content
Determine input `Markdown` content.
**type:** `str`
**default value:** `""`
```python
markdown = Markdown(content="Some content")
```
### height
Determine `Widget` height.
**type:** `int`
**default value:** `300`
```python
markdown = Markdown(content="Some content", height=30)
```
### show\_border
Determine `Widget` height.
**type:** `bool`
**default value:** `True`
```python
markdown = Markdown(content="Lorem ipsum ...", show_border=False)
```
### widget\_id
ID of the widget.
**type:** `str`
**default value:** `None`
## Methods and attributes
| Attributes and Methods | Description |
| :-------------------------: | ------------------------- |
| `set_content(content: str)` | Set `Markdown` data. |
| `get_content()` | Return `Markdown` data. |
| `get_height()` | Return `Markdown` height. |
| `set_height(height: int)` | Set `Markdown` height. |
## Mini App Example
You can find this example in our Github repository:
[supervisely-ecosystem/ui-widgets-demos/text-elements/005\_markdown/src/main.py](https://github.com/supervisely-ecosystem/ui-widgets-demos/blob/master/text%20elements/005_markdown/src/main.py)
### Import libraries
```python
import os
import supervisely as sly
from dotenv import load_dotenv
from supervisely.app.widgets import Card, Container, Flexbox, Markdown, Button
```
### Init API client
First, we load environment variables with credentials and init API for communicating with Supervisely Instance:
```python
load_dotenv("local.env")
load_dotenv(os.path.expanduser("~/supervisely.env"))
api = sly.Api()
```
### Initialize `Button` widgets, we will use
```python
button_text = Button(text="Set md text")
button_clean = Button(text="Clean md")
button_readme = Button(text="Set md readme")
buttons_container = Flexbox(widgets=[button_text, button_clean, button_readme])
```
### Initialize `Markdown` widget
```python
md_path = "path/to/README.md"
md = ""
with open(md_path, "r") as f:
md = f.read()
markdown = Markdown(height=400)
```
### Create app layout
Prepare a layout for the app using `Card` widget with the `content` parameter and place widget that we've just created in the `Container` widget.
```python
card = Card(title="Markdown", content=Container([markdown, buttons_container]))
layout = Container(widgets=[card], direction="vertical")
```
### Create app using layout
Create an app object with the layout parameter.
```python
app = sly.Application(layout=layout)
```
### Handle button clicks
```python
@button_text.click
def simple_content():
markdown.set_content("### Title \n *some markdown text*")
@button_clean.click
def clear_content():
markdown.set_content("")
@button_readme.click
def readme_content():
markdown.set_content(md)
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://developer.supervisely.com/app-development/widgets/text-elements/markdown.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
