{"id":20399865,"url":"https://github.com/kitware/trame-markdown","last_synced_at":"2025-10-17T17:59:33.954Z","repository":{"id":84741709,"uuid":"490854019","full_name":"Kitware/trame-markdown","owner":"Kitware","description":"Trame widget to embed markdown content into a trame application","archived":false,"fork":false,"pushed_at":"2025-01-09T21:24:51.000Z","size":124,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-26T08:22:36.877Z","etag":null,"topics":["trame","trame-maintenance-program"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Kitware.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-10T20:40:39.000Z","updated_at":"2025-01-09T21:24:55.000Z","dependencies_parsed_at":"2023-11-09T23:47:37.868Z","dependency_job_id":"f54c3139-7e4a-4cd6-9728-b5acac6da892","html_url":"https://github.com/Kitware/trame-markdown","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Ftrame-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Ftrame-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Ftrame-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Ftrame-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kitware","download_url":"https://codeload.github.com/Kitware/trame-markdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248574586,"owners_count":21127041,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["trame","trame-maintenance-program"],"created_at":"2024-11-15T04:34:41.786Z","updated_at":"2025-10-17T17:59:33.829Z","avatar_url":"https://github.com/Kitware.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":".. |pypi_download| image:: https://img.shields.io/pypi/dm/trame-markdown\n\nMarkdown renderer for trame |pypi_download|\n===========================================================================\n\n.. image:: https://github.com/Kitware/trame-markdown/actions/workflows/test_and_release.yml/badge.svg\n    :target: https://github.com/Kitware/trame-markdown/actions/workflows/test_and_release.yml\n    :alt: Test and Release\n\ntrame-markdown extend trame **widgets** with a component that is capable of rendering Markdown syntax.\nMarkdown 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 \u003chttps://www.markdownguide.org/basic-syntax/\u003e`_.\n\n\nInstalling\n-----------------------------------------------------------\n\ntrame-markdown can be installed with `pip \u003chttps://pypi.org/project/trame-markdown/\u003e`_:\n\n.. code-block:: bash\n\n    pip install --upgrade trame-markdown\n\n\nUsage\n-----------------------------------------------------------\n\nThe `Trame Tutorial \u003chttps://kitware.github.io/trame/docs/tutorial.html\u003e`_ is the place to go to learn how to use the library and start building your own application.\n\nThe `API Reference \u003chttps://trame.readthedocs.io/en/latest/index.html\u003e`_ documentation provides API-level documentation.\n\n\nLicense\n-----------------------------------------------------------\n\ntrame-markdown is made available under the MIT License. For more details, see `LICENSE \u003chttps://github.com/Kitware/trame-markdown/blob/master/LICENSE\u003e`_\nThis license has been chosen to match the one use by `Markdown It Vue \u003chttps://github.com/ravenq/markdown-it-vue/blob/master/LICENSE\u003e`_ which is used under the cover.\n\n\nCommunity\n-----------------------------------------------------------\n\n`Trame \u003chttps://kitware.github.io/trame/\u003e`_ | `Discussions \u003chttps://github.com/Kitware/trame/discussions\u003e`_ | `Issues \u003chttps://github.com/Kitware/trame/issues\u003e`_ | `RoadMap \u003chttps://github.com/Kitware/trame/projects/1\u003e`_ | `Contact Us \u003chttps://www.kitware.com/contact-us/\u003e`_\n\n.. image:: https://zenodo.org/badge/410108340.svg\n    :target: https://zenodo.org/badge/latestdoi/410108340\n\n\nEnjoying trame?\n-----------------------------------------------------------\n\nShare your experience `with a testimonial \u003chttps://github.com/Kitware/trame/issues/18\u003e`_ or `with a brand approval \u003chttps://github.com/Kitware/trame/issues/19\u003e`_.\n\n\nCode sample\n-----------------------------------------------------------\n\n.. code-block:: python\n\n    from trame.widgets import markdown\n\n    widget = markdown.Markdown(\"\"\"\n    \u003e #### The quarterly results look great!\n    \u003e\n    \u003e - Revenue was off the chart.\n    \u003e - Profits were higher than ever.\n    \u003e\n    \u003e  *Everything* is going according to **plan**.\n    \"\"\")\n    widget.update(md_file.read())\n\nBut if you rather be in control of your variable, you can use the property `content`.\n\n.. code-block:: python\n\n    from trame.widgets import markdown\n\n    widget = markdown.Markdown(content=(\"var_name\", \"**hello**\"))\n\n\nDevelopment\n-----------------------------------------------------------\n\nTo update client side, just update the version and run the following commands.\n\n.. code-block:: bash\n\n    mkdir -p trame_markdown/module/serve\n    cd trame_markdown/module/serve\n    curl -L https://registry.npmjs.org/markdown-it-vue/-/markdown-it-vue-1.1.7.tgz | tar --strip-components=1 -xzv\n\n\nJavaScript dependency\n-----------------------------------------------------------\n\nThis Python package bundle the following set of libraries:\n\n* ``github-markdown-css@5.2.0``\n* ``markdown-it@13.0.1``\n* ``markdown-it-anchor@8.6.7``\n* ``markdown-it-container@3.0.0``\n* ``markdown-it-deflist@2.1.0``\n* ``markdown-it-emoji@2.0.2``\n* ``markdown-it-footnote@3.0.3``\n* ``markdown-it-mathjax3@4.3.2``\n* ``markdown-it-sub@1.0.0``\n* ``markdown-it-sup@1.0.0``\n* ``markdown-it-toc-done-right@4.2.0``\n* ``nanoid@4.0.2``\n* ``picocolors@1.0.0``\n* ``shiki@0.14.4``\n* ``shiki-processor@0.1.3``\n\nIf you would like us to upgrade any of those dependencies, `please reach out \u003chttps://www.kitware.com/trame/\u003e`_.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitware%2Ftrame-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkitware%2Ftrame-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitware%2Ftrame-markdown/lists"}