put security disclaimer in README #6

FauconFan · Sep 8, 2024 · dc846a5 · dc846a5
1 parent d1fef67
commit dc846a5
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git 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 '<!-- cmdrun' . | sed 's/.*<!-- cmdrun \(.*\) -->.*/\1/'
+> ``````
+
+
 ## How to
 
 Let's say we have these two files:

diff --git 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 '<!-- cmdrun' . | sed 's/.*<!-- cmdrun \(.*\) -->.*/\1/'
+//! > ``````
+//!
+//!
 //! # How to
 //!
 //! Let's say we have these two files: