Skip to main content

Executes in-line bash in markdown files

Project description


A markdown pre-processor for inline bash.

Have you ever written a command line tool and wanted to include it's output in your documentation?

Then bashdown is for you.

Write your markdown files as usual and include bash code sections as normal using "```bash".

When you pass this file through bashdown, it will run the code in the code block and include that output inside the rest of the markdown.

This was generated using bashdown. Check README.bashdown for the file that's used to generate

This project was inspired by tools like quarto and Rmarkdown, but has significantly fewer dependencies due to it's much more limited scope.


Basic usage is as follows:

# bashdown README.bashdown >

Full usage information can be obtained from the built in help.

bashdown --help
usage: bashdown [-h] filename

Processes in-line bash in markdown files

positional arguments:

optional arguments:
  -h, --help  show this help message and exit

For more information please see the docs


MIT © Mark Sellors

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

bashdown-0.5.0.tar.gz (2.8 kB view hashes)

Uploaded Source

Built Distribution

bashdown-0.5.0-py3-none-any.whl (3.6 kB view hashes)

Uploaded Python 3

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