|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
Raw data
{
"_id": null,
"home_page": "",
"name": "verto",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "markdown,verto,development,textbook,converter,media,richtext,interactive,education,html,book,author,extension",
"author": "University of Canterbury Computer Science Education Research Group",
"author_email": "csse-education-research@canterbury.ac.nz",
"download_url": "https://files.pythonhosted.org/packages/a2/6b/6ce01bd805ecec768060a88a300d5d6d6c44a0eecfac727ad9cc2980e7c3/verto-1.1.1.tar.gz",
"platform": null,
"description": "|Verto Image|\n\n|Build Status|\n\nVerto is an extension of the Python Markdown package, which allows\nauthors to include complex HTML elements with simple text tags in their\nMarkdown files.\n\nBasic Usage\n-----------\n\nVerto allows for an author to quickly include images and content and display\nthem in a panel (similar to a Bootstrap Collapsible Panel) with the following\nmarkdown:\n\n.. code-block::\n\n # Example Header\n\n Example Paragraph\n\n {panel type=\"example\"}\n\n # Example Panel\n\n {image file-path=\"http://placehold.it/350x150\" caption=\"Example Image\"}\n\n {panel end}\n\nWhile Verto has many configuration options it can be used immediately\nwith little code. For example, if the previous markdown is saved in the file\ncalled ``example.md`` then the following would convert that file and print the\noutput to stdout:\n\n.. code-block:: python\n\n from verto import Verto\n\n text = open('example.md', 'r').read()\n converter = Verto()\n result = converter.convert(text)\n\n print(result.html_string)\n\nDocumentation\n-------------\n\nInstallation and usage documentation for Verto can be found on\n`ReadTheDocs`_, and can also be built from the documentation source\nwithin the ``docs/`` directory of the development distribution.\n\nLicense\n-------\n\nVerto is licensed under the MIT License. Read the `license file`_ for\nmore details.\n\nBugs and feature requests\n-------------------------\n\nHave a bug or a feature request? Please first search for `existing and\nclosed issues`_ in our issue tracker. If your problem or idea is not\naddressed yet, please `open a new issue`_.\n\nFAQ\n---\n\n**Where is the changelog?**\n\nThe changelog is available within the `documentation`_.\n\n**How do I install the development version as local package?**\n\n1. ``$ git clone https://github.com/uccser/verto.git``\n2. ``$ cd verto``\n3. ``$ pip3 install .``\n\n.. _ReadTheDocs: http://verto.readthedocs.io/en/latest/\n.. _documentation: http://verto.readthedocs.io/en/latest/changelog.html\n.. _license file: LICENSE.md\n.. _existing and closed issues: https://github.com/uccser/verto/issues\n.. _open a new issue: https://github.com/uccser/verto/issues/new\n\n.. |Build Status| image:: https://travis-ci.org/uccser/verto.svg?branch=master\n :target: https://travis-ci.org/uccser/verto\n\n.. |Verto Image| image:: https://raw.githubusercontent.com/uccser/verto/master/verto/images/verto-logo.png\n :target: https://github.com/uccser/verto\n :alt: Verto GitHub\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Verto is an extension of the Python Markdown package, which allows authors to include complex HTML elements with simple text tags in their Markdown.",
"version": "1.1.1",
"split_keywords": [
"markdown",
"verto",
"development",
"textbook",
"converter",
"media",
"richtext",
"interactive",
"education",
"html",
"book",
"author",
"extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c2eef80f6e6f07c654f7d01df3e56966676361a967742e6f6bc987d27fe2ba55",
"md5": "5df72e77c0552cca431cd965e1b1c0c2",
"sha256": "febd4f351f76f020bf34b3dae222f1b68f49de114b499de1c3baba6d8105eccd"
},
"downloads": -1,
"filename": "verto-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5df72e77c0552cca431cd965e1b1c0c2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 431544,
"upload_time": "2023-01-11T23:33:09",
"upload_time_iso_8601": "2023-01-11T23:33:09.014388Z",
"url": "https://files.pythonhosted.org/packages/c2/ee/f80f6e6f07c654f7d01df3e56966676361a967742e6f6bc987d27fe2ba55/verto-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a26b6ce01bd805ecec768060a88a300d5d6d6c44a0eecfac727ad9cc2980e7c3",
"md5": "bed1db1be72048c90be8d31a1be038a0",
"sha256": "6ed43967cada3be1acc82332b16917cfca17d451c75b189868e29c0758e57794"
},
"downloads": -1,
"filename": "verto-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "bed1db1be72048c90be8d31a1be038a0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 166202,
"upload_time": "2023-01-11T23:33:10",
"upload_time_iso_8601": "2023-01-11T23:33:10.642720Z",
"url": "https://files.pythonhosted.org/packages/a2/6b/6ce01bd805ecec768060a88a300d5d6d6c44a0eecfac727ad9cc2980e7c3/verto-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-11 23:33:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "verto"
}
JSON