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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: trame-markdown-3.0.2.tar.gz
  • Upload date:
  • Size: 2.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.11.1 readme-renderer/44.0 requests/2.32.3 requests-toolbelt/1.0.0 urllib3/2.2.3 tqdm/4.66.5 importlib-metadata/8.5.0 keyring/25.4.1 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.15

File hashes

Hashes for trame-markdown-3.0.2.tar.gz
Algorithm Hash digest
SHA256 8de1b8c4a92a583f12601f28ddeb9b6ad0a7b3d8d43316285f86c64d6035640d
MD5 21b624beaba0bba1a2ceed7a8f71c0bf
BLAKE2b-256 13b03f629d630e3b663c8b64b8466adf31a3cef3a51b7ed981b4a8acf76e5229

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: trame_markdown-3.0.2-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.11.1 readme-renderer/44.0 requests/2.32.3 requests-toolbelt/1.0.0 urllib3/2.2.3 tqdm/4.66.5 importlib-metadata/8.5.0 keyring/25.4.1 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.15

File hashes

Hashes for trame_markdown-3.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c2ef553029f058f1f959d0330ecce584a4681ae0b05fd188748262b1ab68851c
MD5 153268e056122ff7d0f26d6ab6bb9661
BLAKE2b-256 ad378b98ca08242e08708de5c55e5c79cc618b73351b04bf3f4a290d7d20ddb7

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