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.0rc5.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file trame-markdown-2.0.0rc5.tar.gz.

File metadata

  • Download URL: trame-markdown-2.0.0rc5.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/32.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.7 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.7

File hashes

Hashes for trame-markdown-2.0.0rc5.tar.gz
Algorithm Hash digest
SHA256 4d2c440cea93593e14e2d55765e47e675afeff41bb4b12c14a5a141177fbbe27
MD5 6055cb71aa12d1aef75297ca4e45848f
BLAKE2b-256 314b2ec3e5e361601f8db307fe548c0235eb57a4205cbbf6cbe73bbff458abf5

See more details on using hashes here.

Provenance

File details

Details for the file trame_markdown-2.0.0rc5-py3-none-any.whl.

File metadata

  • Download URL: trame_markdown-2.0.0rc5-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/32.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.7 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.7

File hashes

Hashes for trame_markdown-2.0.0rc5-py3-none-any.whl
Algorithm Hash digest
SHA256 aa1ccbd78eb1ceb3a5543a1f940e9081c1b2ab5b8d3f575a51399b63a740dc17
MD5 c764e838ae2ef43a104adbdffaa75fa3
BLAKE2b-256 4b0ad41b4f4f493751f2d379378693e2c93ba865c8b5cfabbc64f42dc405386d

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