Metadata-Version: 2.1
Name: mkmd
Version: 0.0.1b1
Summary: Create Markdown documents
License: MIT
Project-URL: repository, https://github.com/phoenixr-codes/mkmd/
Project-URL: documentation, https://phoenixr-codes.github.io/mkmd/
Keywords: Documentation,Generator,Markdown,Markup
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing :: Markup
Classifier: Topic :: Text Processing :: Markup :: Markdown
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: docs

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")
```
