Skip to content

The Bash Tutorial mdbook preprocessor allows you to import a Bash script in your book

License

Notifications You must be signed in to change notification settings

filariow/mdbook-bash-tutorial

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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"
    ```

About

The Bash Tutorial mdbook preprocessor allows you to import a Bash script in your book

Topics

Resources

License

Stars

Watchers

Forks