Simple (pythonic) MarkDown Generator
Project description
Simple (pythonic) MarkDown Generator
Modules to programmatically generate MarkDown source code in a pythonic way
pip install smdg
Installation in a virtual environment is strongly recommended.
Example usage
Use the classes in the smdg.elements module to create MarkDown elements.
Some elements may be nested, and the smdg.elements.render() function can be used to return a MarkDown document (consisting of the provided elements) as a single string.
>>> from smdg import elements as me
>>>
>>> h1 = me.Header(1, "Main header")
>>> h2 = me.Header(2, "Printing colors:")
>>> p = me.Paragraph("Lorem ipsum dolor sit amet,\nconsectetuer adipiscing elit.")
>>> pre = me.CodeBlock('def main() -> int:\n """main function"""\n return 0')
>>> ul = me.UnorderedList("Cyan", "Magenta", "Yellow", "Key")
>>>
>>> print(h1)
# Main header
>>> print(h2)
## Printing colors:
>>> print(p)
Lorem ipsum dolor sit amet,
consectetuer adipiscing elit.
>>>
>>> print(me.render(h1, p, pre, h2, ul))
# Main header
Lorem ipsum dolor sit amet,
consectetuer adipiscing elit.
def main() -> int:
"""main function"""
return 0
## Printing colors:
* Cyan
* Magenta
* Yellow
* Key
>>>
>>> print(me.BlockQuote(h1, p, pre, h2, ul))
> # Main header
>
> Lorem ipsum dolor sit amet,
> consectetuer adipiscing elit.
>
> def main() -> int:
> """main function"""
> return 0
>
> ## Printing colors:
>
> * Cyan
> * Magenta
> * Yellow
> * Key
>>>
Further reading
Please see the documentation at https://blackstream-x.gitlab.io/smdg for detailed usage information.
If you found a bug or have a feature suggestion, please open an issue here
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file smdg-0.2.1.tar.gz
.
File metadata
- Download URL: smdg-0.2.1.tar.gz
- Upload date:
- Size: 16.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 94a396803c86092f7a9a5adedf728c11e057335355b0707e7aaed55777398612 |
|
MD5 | 8a876ced8cc661ebe28a882fa95b489d |
|
BLAKE2b-256 | 99807bb65d8506afa0ef84660bbf2e9d416b7092cdca62feccb9ea5bcc37d142 |
Provenance
File details
Details for the file smdg-0.2.1-py3-none-any.whl
.
File metadata
- Download URL: smdg-0.2.1-py3-none-any.whl
- Upload date:
- Size: 14.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1dbb47ff13e92329f86e2a26b78adbc4efbcd107e2f5c1ccde960cca3799c5f6 |
|
MD5 | 5be64d07588948500cba47b309e12b3a |
|
BLAKE2b-256 | dce2383ea7d227288ae5b91f531301d2176f0443a243db5300c3a7a8da2f9dba |