Skip to content

Commit

Permalink
md component spec
Browse files Browse the repository at this point in the history
  • Loading branch information
wusteven815 committed Sep 23, 2024
1 parent 5581ae4 commit 1fb246b
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions plugins/ui/DESIGN.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,32 @@ st.write("Result:", res)
- Re-running everything can be costly, need to be conscious with caching/memoization
- Does not achieve composability

### Markdown Component

The markdown component should take a string and render it with Markdown formatting. The component should also support LaTeX with MathJax, and use all the props in the Layout, Spacing, Sizing, Positioning, Accessibility, and Advanced categories from Spectrum.

```python
from deephaven import ui

md_example = ui.markdown(
"""
# Heading 1
## Heading 2
Text **bold**
$$
\eqalign{
(a+b)^2 &= (a+b)(a+b) \\
&= a^2 + ab + ba + b^2 \\
&= a^2 + 2ab + b^2
}
$$
"""
)
```

## Proposed Syntaxes

### Interactive Query
Expand Down

0 comments on commit 1fb246b

Please sign in to comment.