Metadata-Version: 2.1
Name: minsert
Version: 0.0.15
Summary: Insert dynamic content in markdown, without using a separate template file.
Home-page: https://github.com/aahnik/minsert
License: MIT
Keywords: python,cli,markdown,file
Author: aahnik
Author-email: daw@aahnik.dev
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Project-URL: Repository, https://github.com/aahnik/minsert
Description-Content-Type: text/markdown

# minsert

Insert dynamic content in markdown, without using a separate template file.

## Motivation

Inspired by jinja. 😂

Your actual markdown file is the template file itself.
Just make a block of content just by using comments, which indicate the start and
end of the block.

This is really great for GitHub repo README. No hassle of creating a separate
template file.

## Installation

```shell
pip install minsert
```

## Syntax

Start a block : `<!-- start: thing -->`

End of a block: `<!-- end -->`

You must end current block before starting a new one.

## Usage

```python
from minsert import MarkdownFile
file = MarkdownFile('test.md')
things = {'thing1': 'hi hello',
          'thing2': 'ping pong',
          }
file.insert(things)

```

## Example

Take a long hard look at this gif!

![minsert](https://user-images.githubusercontent.com/66209958/99037312-7bb39700-25a9-11eb-9d1e-2a15d76a8d10.gif)

