Metadata-Version: 2.1
Name: mkmd
Version: 0.0.1b0
Summary: Create markdown documents
License: MIT
Requires-Python: >=3.7
Description-Content-Type: text/markdown

mkmd
====

Installation
------------

```bash
pip install mkmd
```


Basic Usage
-----------

```python
import mkmd
from mkmd.utils import *

md = mkmd.Markdown()

md.add_heading(f"Hello {bold_and_italic('MKMD')}",)

md.add_paragraph(f"""
    This markdown document was generated by using
    {refer('mkmd', '1')}. This is a quick example showing how to
    use it:
""")

md.add_codeblock("""
    import mkmd
    
    md = mkmd.Markdown()
    md.add_heading("Hello World")
    md.add_paragraph("Lorem ipsum dolor sit amet.")
""", language = "python")

md.add_ordered_list(
    *"So many things are possible!".split()
)

md.add_reference("1", "http://example.org", "Look at this")

md.add_image("Linux Mascot",
    "https://mdg.imgix.net/assets/images/tux.png?auto=format&fit=clip&q=40&w=100"
)

if __name__ == "__main__":
    md.save("example_result.md")
```
