https://github.com/uccser/verto
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.
https://github.com/uccser/verto
markdown python python-3 writing
Last synced: 7 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/uccser/verto
- Owner: uccser
- License: other
- Created: 2016-07-26T03:10:01.000Z (almost 10 years ago)
- Default Branch: develop
- Last Pushed: 2024-07-16T20:11:12.000Z (almost 2 years ago)
- Last Synced: 2025-09-25T06:38:42.370Z (9 months ago)
- Topics: markdown, python, python-3, writing
- Language: Python
- Homepage:
- Size: 1.63 MB
- Stars: 3
- Watchers: 5
- Forks: 1
- Open Issues: 19
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE.rst
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
|Verto Image|
|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:
.. code-block::
# 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:
.. code-block:: python
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 .``
.. _ReadTheDocs: http://verto.readthedocs.io/en/latest/
.. _documentation: http://verto.readthedocs.io/en/latest/changelog.html
.. _license file: LICENSE.md
.. _existing and closed issues: https://github.com/uccser/verto/issues
.. _open a new issue: https://github.com/uccser/verto/issues/new
.. |Build Status| image:: https://travis-ci.org/uccser/verto.svg?branch=master
:target: https://travis-ci.org/uccser/verto
.. |Verto Image| image:: https://raw.githubusercontent.com/uccser/verto/master/verto/images/verto-logo.png
:target: https://github.com/uccser/verto
:alt: Verto GitHub