selfhoster1312/static-serve
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: fix docs for accepted inputs for directories

Browse Source
This commit is contained in:
Angel Hudgins 2025-04-02 15:24:57 +02:00 committed by Paolo Barbolini
parent 1a3ed22f02
commit 2e9b8b28ce
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -49,13 +49,13 @@ The crate automatically handles:
### Required parameter ### Required parameter
- `path_to_dir` - a valid Rust identifier or `&str` of the path to the static files to be included - `path_to_dir` - a valid `&str` string literal of the path to the static files to be included
### Optional parameters ### Optional parameters
- `compress = false` - compress static files with zstd and gzip, true or false (defaults to false) - `compress = false` - compress static files with zstd and gzip, true or false (defaults to false)
- `ignore_dirs = [my_ignore_dir, other_ignore_dir]` - a bracketed list of valid Rust identifiers or `&str`s of the paths/subdirectories inside the target directory, which should be ignored and not included. (If this parameter is missing, no subdirectories will be ignored) - `ignore_dirs = [my_ignore_dir, other_ignore_dir]` - a bracketed list of `&str`s of the paths/subdirectories inside the target directory, which should be ignored and not included. (If this parameter is missing, no subdirectories will be ignored)
## Example ## Example

4
static-serve/README.md
View File

@ -46,12 +46,12 @@ The crate automatically handles:
### Required parameter ### Required parameter
- `path_to_dir` - a valid Rust identifier or `&str` of the path to the static files to be included - `path_to_dir` - a valid `&str` string literal of the path to the static files to be included
### Optional parameters ### Optional parameters
- `compress = false` - compress static files with zstd and gzip, true or false (defaults to false) - `compress = false` - compress static files with zstd and gzip, true or false (defaults to false)
- `ignore_dirs = [my_ignore_dir, other_ignore_dir]` - a bracketed list of valid Rust identifiers or `&str`s of the paths/subdirectories inside the target directory, which should be ignored and not included. (If this parameter is missing, no subdirectories will be ignored) - `ignore_dirs = [my_ignore_dir, other_ignore_dir]` - a bracketed list of `&str`s of the paths/subdirectories inside the target directory, which should be ignored and not included. (If this parameter is missing, no subdirectories will be ignored)
## Example ## Example