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.2.0.tar.gz (166.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

verto-1.2.0-py3-none-any.whl (433.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: verto-1.2.0.tar.gz
  • Upload date:
  • Size: 166.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for verto-1.2.0.tar.gz
Algorithm Hash digest
SHA256 73bb279056215936ea4e0a2203ae9e8605679899658175e0e29fa7a258b3ab78
MD5 6f1c775254e39114f4ad4c8e845e22c2
BLAKE2b-256 aca829c273636e9d8d82018b139970d0296294a88b86dfccee948afc495629f1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: verto-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 433.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for verto-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bdfd9e17dbe71c140fb4fbae524680391c8998aef473d5d9577ac84d487f73aa
MD5 b3f988e1119bbf31f8f5314069d78c77
BLAKE2b-256 06708344dbb6243b9311fec43fcace1455346900ae27fe3ecfab4ee2cb8ddc31

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page