mdbook-bash-tutorial 0.1.4

A mdbook preprocessor that allows embedding Bash scripts as tutorials
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

# mdbook bash tutorial

:warning: this preprocessor is not production ready, use it with caution :warning:

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.

## Example

1. `chapter-1.md`
    ```markdown
    # Chapter 1

    {{#tutorial ./example/bash-script.sh}}
    ```
1. `example/bash-script.sh`
    ```bash
    #!/bin/bash

    ## Title
    echo "command"
    sleep 1000  # mdbash: skip-line

    ## Title-2
    echo "command-2"
    ```
1. Built chapter
    ````markdown
    # Chapter 1

    1. Title
    ```console
    echo "command"
    ```
    2. Title-2
    ```console
    echo "command-2"
    ```
    ````