Metadata-Version: 2.1
Name: minsert
Version: 0.0.1
Summary: Insert dynamic content in markdown, without using a seperate template file
Home-page: https://github.com/aahnik/py-utility-pack
Author: Aahnik Daw
Author-email: meet.aahnik@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
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 : `<!-- ➡️ thing1 ⬅️ -->`

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

Emoji Tip:

- use :emojisense: in VS Code
- ➡️ `:arrow_right:`
- ⬅️ `:arrow_left:`
- 🛑 `:stop_sign:`

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


