Skip to main content

bashdown

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 README.md was generated using bashdown. Check README.bashdown for the file that's used to generate README.md

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

Usage

Basic usage is as follows:

# bashdown README.bashdown > README.md

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:
  filename

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

For more information please see the docs

License

MIT © Mark Sellors

Metadata

Release files for bashdown 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bashdown 0.5.0
File Size Uploaded Provenance Actions
bashdown-0.5.0.tar.gz 2.8 kB Without provenance Details for bashdown-0.5.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for bashdown 0.5.0
File Interpreter ABI Platform Actions
bashdown-0.5.0-py3-none-any.whl Python 3 none any Details for bashdown-0.5.0-py3-none-any.whl

Total release size: 6.5 kB

Release files / bashdown-0.5.0.tar.gz

Download URL bashdown-0.5.0.tar.gz
Size 2.8 kB
Tags Source
SHA-256 checksum
How to use checksums
ae9d96d8b9dca2252ac7be2b29aaba192d6942ecb816367ee6019636be9161ed
BLAKE2b-256 checksum
How to use checksums
12a4463b9913f4b28418ec95aa989ade91a4524adbf19f12e5c27a3dfa89f1f4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.0 CPython/3.9.2 Linux/5.15.84-v7l+

Release files / bashdown-0.5.0-py3-none-any.whl

Download URL bashdown-0.5.0-py3-none-any.whl
Size 3.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5d05fa8965ecb9ecea4687b937c8a7b5e5433ac1587c9c92560a17e3d867742f
BLAKE2b-256 checksum
How to use checksums
f26a9d6d61b7ddac084f42f8c74f7cef913b047b0c9e1c3ac1006e97424e7d0f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.0 CPython/3.9.2 Linux/5.15.84-v7l+

Security for bashdown 0.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page