mdbook-bash-tutorial

Crates.iomdbook-bash-tutorial
lib.rsmdbook-bash-tutorial
version0.1.6
sourcesrc
created_at2023-06-20 10:28:37.749433
updated_at2023-10-03 09:33:31.643494
descriptionA mdbook preprocessor that allows embedding Bash scripts as tutorials
homepage
repositoryhttps://github.com/filariow/mdbook-bash-tutorial
max_upload_size
id894911
size66,185
Francesco Ilario (filariow)

documentation

README

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"
    ```
    
Commit count: 11

cargo fmt