Skip to main content

A CLI tool to execute commands inside Markdown files

Project description

Maked: A Command-Line Tool to Automate Markdown Processing

PyPI version License: MIT

maked is a CLI tool that executes shell commands embedded in the YAML front matter of Markdown files. Keep your commands co-located with your documents — no separate Makefile or shell script needed.

pip install maked

Usage

Add a maked field to your Markdown file's YAML front matter:

---
maked: 'pandoc example.md -o example.pdf'
---

# My Document

Content here.

Then run:

maked example.md

You can also pipe content via stdin:

echo -e "---\nmaked: 'pandoc example.md -o output.pdf'\n---\nSome content here" | maked

Preview the command without executing it:

maked --dry-run example.md

Why Maked?

Makefile Shell script maked
Lives next to your document
No extra syntax to learn
Works with any shell command
Stdin support

Installation

pip install maked

Or with Poetry:

poetry add maked

Contributing

  1. Fork the repository and clone it locally.
  2. Install dependencies: poetry install --with dev
  3. Make your changes.
  4. Run tests: poetry run pytest
  5. Open a pull request.

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

maked-0.1.1.tar.gz (2.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

maked-0.1.1-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

Details for the file maked-0.1.1.tar.gz.

File metadata

  • Download URL: maked-0.1.1.tar.gz
  • Upload date:
  • Size: 2.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.13.2 Darwin/25.2.0

File hashes

Hashes for maked-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c4ee651beb5aa1902df6fa04798c566e4b93e7f8486819f124215e2939ffe3ed
MD5 44298e70e7c8391839ece0abdff52453
BLAKE2b-256 2d432a0cee6892b6cf67126391d3905b02eb3ff7bc0e435e4e376a0add5049a2

See more details on using hashes here.

File details

Details for the file maked-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: maked-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 3.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.13.2 Darwin/25.2.0

File hashes

Hashes for maked-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2ba95ef9a14d2c2376b2f0f6083ace0695122230428cf398586fa90a7defb0e6
MD5 232a926cfdf6787f39c4edd78d0cd7a8
BLAKE2b-256 f6fe672974cf1296deeb3c3d5db9ab2d1c856a717df1eed1af8737df8cbca7e7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page