Skip to main content

Insert dynamic content in markdown, without using a seperate template file

Project description

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

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

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

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

minsert-0.0.1.tar.gz (2.7 kB view details)

Uploaded Source

Built Distribution

minsert-0.0.1-py3-none-any.whl (2.8 kB view details)

Uploaded Python 3

File details

Details for the file minsert-0.0.1.tar.gz.

File metadata

  • Download URL: minsert-0.0.1.tar.gz
  • Upload date:
  • Size: 2.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.9.0

File hashes

Hashes for minsert-0.0.1.tar.gz
Algorithm Hash digest
SHA256 24c352b7442b3b5ab12e848195931aed9290fbf283908994357dff13b352084d
MD5 2a6d7b57c52e3a2191916e784c3dafa5
BLAKE2b-256 a4be720e4a66b81f43160b96186875dce5b0422cedf7f7f7e7f3f73a16c37eb2

See more details on using hashes here.

File details

Details for the file minsert-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: minsert-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 2.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.9.0

File hashes

Hashes for minsert-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ec1ec5e98d5832ed6a297ab68f7eb82eb199d769a53925154c813e4675449748
MD5 2f246a2e8ee5af0108ce7701a213d83d
BLAKE2b-256 bbc6588a8d753209b5ba90c4a854452117f468b63b13a3e5fc184e883862f6ab

See more details on using hashes here.

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