Skip to main content

Markdown widget for trame

Project description

Test and Release

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-3.0.1.tar.gz (2.5 MB view details)

Uploaded Source

Built Distribution

trame_markdown-3.0.1-py3-none-any.whl (2.6 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: trame-markdown-3.0.1.tar.gz
  • Upload date:
  • Size: 2.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/42.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.0.7 tqdm/4.66.1 importlib-metadata/6.8.0 keyring/24.2.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.13

File hashes

Hashes for trame-markdown-3.0.1.tar.gz
Algorithm Hash digest
SHA256 b93d06ba6fa508dcd6982aee2730b6f50b35e92dbbf7b44734eede32e9dfd340
MD5 61ac663321802336989cc694d11d7da2
BLAKE2b-256 7386cbc3ab78026b7f0950f3482e7af981938c752a784968d26f4c0f15481e86

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: trame_markdown-3.0.1-py3-none-any.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/42.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.0.7 tqdm/4.66.1 importlib-metadata/6.8.0 keyring/24.2.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.13

File hashes

Hashes for trame_markdown-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 57b7101961ad3c3fa9a470c7e94c00da7b1472d4cb8f99d52e391e74a035e353
MD5 f61fd58803e76e2cf4ffb004fc5b2aac
BLAKE2b-256 90e8fee75f90c18bb8aed9539a74d43d40330f1e514a0412372a1c14fce474f1

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