#bash #mdbook #tutorial #preprocessor #markdown #build-time

bin+lib mdbook-bash-tutorial

一个允许嵌入 Bash 脚本作为教程的 mdbook 预处理器

2 个版本

0.1.6 2023 年 10 月 3 日
0.1.5 2023 年 6 月 26 日

#1104文本处理

每月 43 次下载

MIT/Apache

20KB
330

mdbook bash tutorial

⚠️ 这个预处理器不适用于生产环境,请谨慎使用 ⚠️

Bash 教程 mdbook 预处理器允许你在书中导入 Bash 脚本。脚本易于测试,并在构建时嵌入到书中。

示例

  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. 构建的章节
    # Chapter 1
    
    1. Title
    ```console
    echo "command"
    ```
    2. Title-2
    ```console
    echo "command-2"
    ```
    

依赖项

~12–24MB
~332K SLoC