diff --git a/README.md b/README.md index 0135d1e..5da42b2 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,13 @@ You also have to activate the preprocessor, put this in your `book.toml` file: [preprocessor.cmdrun] ``` +> :warning: This preprocessor presents a security risk, as arbitrary commands can be run. Be careful with the commands you run. +> To list all the commands that will be run within an mdbook, you can run the following command: +> ```sh +> grep -r '.*/\1/' +> `````` + + ## How to Let's say we have these two files: diff --git a/src/lib.rs b/src/lib.rs index dec6d1c..6f453f3 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -11,6 +11,13 @@ //! [preprocessor.cmdrun] //! ``` //! +//! > :warning: This preprocessor presents a security risk, as arbitrary commands can be run. Be careful with the commands you run. +//! > To list all the commands that will be run within an mdbook, you can run the following command: +//! > ```sh +//! > grep -r '.*/\1/' +//! > `````` +//! +//! //! # How to //! //! Let's say we have these two files: