Skip to main content

Verto is an extension of the Python Markdown package, which allows authors to include complex HTML elements with simple text tags in their Markdown.

Project description

Verto GitHub

Build Status

Verto is an extension of the Python Markdown package, which allows authors to include complex HTML elements with simple text tags in their Markdown files.

Basic Usage

Verto allows for an author to quickly include images and content and display them in a panel (similar to a Bootstrap Collapsible Panel) with the following markdown:

# Example Header

Example Paragraph

{panel type="example"}

# Example Panel

{image file-path="http://placehold.it/350x150" caption="Example Image"}

{panel end}

While Verto has many configuration options it can be used immediately with little code. For example, if the previous markdown is saved in the file called example.md then the following would convert that file and print the output to stdout:

from verto import Verto

text = open('example.md', 'r').read()
converter = Verto()
result = converter.convert(text)

print(result.html_string)

Documentation

Installation and usage documentation for Verto can be found on ReadTheDocs, and can also be built from the documentation source within the docs/ directory of the development distribution.

License

Verto is licensed under the MIT License. Read the license file for more details.

Bugs and feature requests

Have a bug or a feature request? Please first search for existing and closed issues in our issue tracker. If your problem or idea is not addressed yet, please open a new issue.

FAQ

Where is the changelog?

The changelog is available within the documentation.

How do I install the development version as local package?

  1. $ git clone https://github.com/uccser/verto.git

  2. $ cd verto

  3. $ pip3 install .

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

verto-1.1.1.tar.gz (166.2 kB view details)

Uploaded Source

Built Distribution

verto-1.1.1-py3-none-any.whl (431.5 kB view details)

Uploaded Python 3

File details

Details for the file verto-1.1.1.tar.gz.

File metadata

  • Download URL: verto-1.1.1.tar.gz
  • Upload date:
  • Size: 166.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for verto-1.1.1.tar.gz
Algorithm Hash digest
SHA256 6ed43967cada3be1acc82332b16917cfca17d451c75b189868e29c0758e57794
MD5 bed1db1be72048c90be8d31a1be038a0
BLAKE2b-256 a26b6ce01bd805ecec768060a88a300d5d6d6c44a0eecfac727ad9cc2980e7c3

See more details on using hashes here.

File details

Details for the file verto-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: verto-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 431.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for verto-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 febd4f351f76f020bf34b3dae222f1b68f49de114b499de1c3baba6d8105eccd
MD5 5df72e77c0552cca431cd965e1b1c0c2
BLAKE2b-256 c2eef80f6e6f07c654f7d01df3e56966676361a967742e6f6bc987d27fe2ba55

See more details on using hashes here.

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