Crates.io | mdbook-bash-tutorial |
lib.rs | mdbook-bash-tutorial |
version | 0.1.6 |
source | src |
created_at | 2023-06-20 10:28:37.749433 |
updated_at | 2023-10-03 09:33:31.643494 |
description | A mdbook preprocessor that allows embedding Bash scripts as tutorials |
homepage | |
repository | https://github.com/filariow/mdbook-bash-tutorial |
max_upload_size | |
id | 894911 |
size | 66,185 |
⚠️ this preprocessor is not production ready, use it with caution ⚠️
The Bash Tutorial mdbook preprocessor allows you to import a Bash script in your book. Scripts remain easily testable and are embedded in the book at build time.
chapter-1.md
# Chapter 1
{{#tutorial ./example/bash-script.sh}}
example/bash-script.sh
#!/bin/bash
## Title
echo "command"
sleep 1000 # mdbash: skip-line
## Title-2
echo "command-2"
# Chapter 1
1. Title
```console
echo "command"
```
2. Title-2
```console
echo "command-2"
```