aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSven-Hendrik Haase <svenstaro@gmail.com>2025-03-07 00:48:52 +0000
committerSven-Hendrik Haase <svenstaro@gmail.com>2025-03-07 00:48:52 +0000
commita7d658e2dac7159a31279f1a86a796f1bc27381e (patch)
tree6657507db5a148a6c29e59e5e731c7e0ee4d9c5b
parentMake exact byte formatting consistent with human format (diff)
downloadminiserve-a7d658e2dac7159a31279f1a86a796f1bc27381e.tar.gz
miniserve-a7d658e2dac7159a31279f1a86a796f1bc27381e.zip
Document ?raw=true
This was previously only implicitly documented via --show-wget-footer flag (fixes #1088)
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8a8f78d..b3b5e44 100644
--- a/README.md
+++ b/README.md
@@ -103,6 +103,21 @@ this example, you'd need to use `-u -v`.
(where `$DIR_NAME` is the name of the directory. This uses miniserve's default port of 8080.)
+### Use the raw renderer for use with simple viewers
+
+You can pass `?raw=true` with requests where you only require minimal HTML output for CLI-based browsers such as `lynx` or `w3m`.
+This is enabled by default without any extra flags:
+
+ miniserve .
+ curl http://localhost:8080?raw=true
+
+You can enable a convenient copy-pastable footer for `wget` using `--show-wget-footer`:
+
+ miniserve --show-wget-footer .
+
+Afterwards, check the bottom of any rendered page.
+It'll have a neat `wget` command you can easily copy-paste to recursively grab the current directory.
+
### Take pictures and upload them from smartphones:
miniserve -u -m image -q
@@ -276,7 +291,7 @@ Options:
--web-upload-files-concurrency <WEB_UPLOAD_CONCURRENCY>
Configure amount of concurrent uploads when visiting the website. Must have upload-files option enabled for this setting to matter.
-
+
[env: MINISERVE_WEB_UPLOAD_CONCURRENCY=]
[default: 0]