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')
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.

Filename, size & hash SHA256 hash help File type Python version Upload date
verto-0.10.0-py3-none-any.whl (421.2 kB) Copy SHA256 hash SHA256 Wheel py3
verto-0.10.0.tar.gz (158.0 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page