Metadata-Version: 2.1
Name: markdown-builder
Version: 0.1.0
Summary: Create Markdown from a Python program
Home-page: https://github.com/romilly/markdown-builder
Author: Romilly Cocking
Author-email: romilly.cocking@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/romilly/markdown-builder/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# markdown-builder

`markdown-builder` is a minimalist package for creating [MarkDown](https://en.wikipedia.org/wiki/Markdown)
documents in a Python program. At present, it only supports the features required
by those applications but I'm happy to get suggestions for additions.

It requires Python 3.

It grew out of a number of Python applications that needed similar functionality.

The [DRY principle](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself) 
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.

## Installation

`pip3 install markdown-builder.`

## Quickstart

The following Python program will generate [SAMPLE.md](SAMPLE.md)

```python
from markdown_builder.document import MarkdownDocument

md = MarkdownDocument()
md.append_heading('Welcome to MarkDown')
md.append_text('markdown-builder is really 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)
```




