Skip to main content

Create Markdown from a Python program

Project description


markdown-builder is a minimalist package for creating MarkDown documents in a Python program.

It requires Python 3.

It grew out of a number of Python applications that needed similar functionality. At present, it only supports the features required by those applications, but I'm open to suggestions for additions.

The DRY principle led me to separate out the code into a separate package.

With markdown-builder you can build a Markdown document in a few lines of Python code.


pip3 install markdown-builder.


The following Python program will generate

from markdown_builder.document import MarkdownDocument

md = MarkdownDocument()
md.append_heading('Welcome to MarkDown')
md.append_text('markdown-builder is really easy to use')
md.append_heading('This is a level2 heading', 2)
md.append_text_indented('This is inset', depth=1)
md.append_bullet('This is a top-level bullet point')
md.append_bullet('This is a lower level bullet point', depth=1)

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

markdown-builder-0.1.2.tar.gz (3.2 kB view hashes)

Uploaded source

Built Distribution

markdown_builder-0.1.2-py3-none-any.whl (3.7 kB view hashes)

Uploaded py3

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