https://github.com/filariow/mdbook-bash-tutorial
The Bash Tutorial mdbook preprocessor allows you to import a Bash script in your book
https://github.com/filariow/mdbook-bash-tutorial
bash mdbook mdbook-preprocessor tutorials
Last synced: 5 months ago
JSON representation
The Bash Tutorial mdbook preprocessor allows you to import a Bash script in your book
- Host: GitHub
- URL: https://github.com/filariow/mdbook-bash-tutorial
- Owner: filariow
- License: mit
- Created: 2023-06-19T10:28:31.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-01T23:52:40.000Z (almost 2 years ago)
- Last Synced: 2025-09-15T11:48:50.488Z (9 months ago)
- Topics: bash, mdbook, mdbook-preprocessor, tutorials
- Language: Rust
- Homepage:
- Size: 115 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
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`
```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"
```
````