makedown 0.0.0

A CLI utility to execute scripts from within markdown files.

makedown

makedown is a versatile CLI tool that lets you execute shell scripts, JavaScript code, and Python code from one or more markdown files. It's a streamlined alternative to Makefile or package.json scripts, and it features built-in syntax highlighting through markdown code blocks.

Key Features

• Multilingual Execution: Supports Zsh, JavaScript, and Python.
• Simplified Scripting: Use markdown files (.md) to organize and run commands.
• Syntax Highlighting: Leverages markdown code blocks for readability.
• Autocomplete Support: ZSH completions for a smoother workflow.
• support tripple backtick code blocks

Install

pip install makedown

Usage

Define and document your commands in a markdown file, like DEMO.md.

Then use makedown to run them, from within the same directory or any subdirectory.

$ makedown --help # Prints help with available commands
$ makedown # Also prints help

$ makedown my_command # Runs the command
$ makedown my_command arg1 arg2 # Pass arguments to the command
$ makedown my_command --help # Prints help for the command

Development

dev:venv:create Creates a virtual environment.

python3 -m venv venv

Activate the virtual environment.

source venv/bin/activate

dev:install Installs python dependencies.

pip install setuptools wheel twine

dev:build Builds the package.

python setup.py sdist bdist_wheel

dev:publish Publishes the package to pypi.

twine upload dist/*