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
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file trame-markdown-2.0.0rc4.tar.gz
.
File metadata
- Download URL: trame-markdown-2.0.0rc4.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
Algorithm | Hash digest | |
---|---|---|
SHA256 | 535595f5f7696213fba26c0c14d9fc1bb2aea8ba796844d2a930e6522a362386 |
|
MD5 | 3eb733319fd556fc228a43aca7ff86a1 |
|
BLAKE2b-256 | 5230da6ca5cfd86d1f5b65efecc07b576ac4113322c671c853ce4eb47263ad14 |
Provenance
File details
Details for the file trame_markdown-2.0.0rc4-py3-none-any.whl
.
File metadata
- Download URL: trame_markdown-2.0.0rc4-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
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe7418620b7a669f81bf94abd64ec70f940672eb30514d963d2e572d6f2b3e12 |
|
MD5 | a2139650eec8111fe5b2d8674115d06d |
|
BLAKE2b-256 | 6528eb04be1925ece6b24beba8a1610b6db59ebb80df0ec9b3c164d37b7aae7a |