Skip to main content

Markdown widget for trame

Project description

trame-markdown extend trame widgets with a component that is capable of rendering Markdown syntax. Markdown integration into trame allow user to display markdown content easily. If you want are wondering what Markdown is, you can look at some online guides.

Installing

trame-markdown can be installed with pip:

pip install --upgrade trame-markdown

Usage

The Trame Tutorial is the place to go to learn how to use the library and start building your own application.

The API Reference documentation provides API-level documentation.

License

trame-markdown is made available under the MIT License. For more details, see LICENSE This license has been chosen to match the one use by Markdown It Vue which is used under the cover.

Community

Trame | Discussions | Issues | RoadMap | Contact Us

https://zenodo.org/badge/410108340.svg

Enjoying trame?

Share your experience with a testimonial or with a brand approval.

Code sample

from trame.widgets import markdown

widget = markdown.Markdown("""
> #### The quarterly results look great!
>
> - Revenue was off the chart.
> - Profits were higher than ever.
>
>  *Everything* is going according to **plan**.
""")
widget.update(md_file.read())

But if you rather be in control of your variable, you can use the property content.

from trame.widgets import markdown

widget = markdown.Markdown(content=("var_name", "**hello**"))

Development

To update client side, just update the version and run the following commands.

mkdir -p trame_markdown/module/serve
cd trame_markdown/module/serve
curl -L https://registry.npmjs.org/markdown-it-vue/-/markdown-it-vue-1.1.7.tgz | tar --strip-components=1 -xzv

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

trame-markdown-2.0.2.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

trame_markdown-2.0.2-py3-none-any.whl (1.5 MB view details)

Uploaded Python 3

File details

Details for the file trame-markdown-2.0.2.tar.gz.

File metadata

  • Download URL: trame-markdown-2.0.2.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/35.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.64.0 importlib-metadata/4.11.4 keyring/23.5.1 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.13

File hashes

Hashes for trame-markdown-2.0.2.tar.gz
Algorithm Hash digest
SHA256 7d4979acb0b2382c144aaa461825b76bde4dc4120869c1a7dda41543485cafc6
MD5 fd6908cdce2c70bd215bdf27c655239e
BLAKE2b-256 405384a06f1d289f13e70336227f36e8019c00304fd3efcbbb0004779588ed14

See more details on using hashes here.

Provenance

File details

Details for the file trame_markdown-2.0.2-py3-none-any.whl.

File metadata

  • Download URL: trame_markdown-2.0.2-py3-none-any.whl
  • Upload date:
  • Size: 1.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/35.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.64.0 importlib-metadata/4.11.4 keyring/23.5.1 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.13

File hashes

Hashes for trame_markdown-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 bc529eb9084b2f6dcf9631b94a0cabdb83a2da379075aadd45071eef1a686d57
MD5 c3e1425b076b37f73620f04775253362
BLAKE2b-256 8448c3b0c6b6b1768fc88545297cf66084a09a991b98e1e903da3d7e436e06e6

See more details on using hashes here.

Provenance

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