mdbook-bash-tutorial 0.1.6

A mdbook preprocessor that allows embedding Bash scripts as tutorials
Documentation

mdbook bash tutorial

⚠️ 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.

Example

  1. chapter-1.md
    # Chapter 1
    
    {{#tutorial ./example/bash-script.sh}}
    
  2. example/bash-script.sh
    #!/bin/bash
    
    ## Title
    echo "command"
    sleep 1000  # mdbash: skip-line
    
    ## Title-2
    echo "command-2"
    
  3. Built chapter
    # Chapter 1
    
    1. Title
    ```console
    echo "command"
    ```
    2. Title-2
    ```console
    echo "command-2"
    ```