Skip to main content

Create markdown documents

Project description

mkmd

Installation

pip install mkmd

Basic Usage

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkmd-0.0.1b0.tar.gz (3.8 kB view hashes)

Uploaded Source

Built Distribution

mkmd-0.0.1b0-py3-none-any.whl (4.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page