From 6eec535d0df36fbd2872c2d6380b254d4d6ee4c2 Mon Sep 17 00:00:00 2001
From: gosver <31957860+gosver@users.noreply.github.com>
Date: Tue, 18 Mar 2025 13:23:48 +0300
Subject: [PATCH] Add information about static routes
Static Files Handling Note: This plugin does not process or rewrite URLs starting with /static/ from the your root
---
README.md | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/README.md b/README.md
index fb7e4ca..77187ae 100644
--- a/README.md
+++ b/README.md
@@ -144,6 +144,12 @@ export default defineConfig({
})
```
+Static Files Handling
+Note: This plugin does not process or rewrite URLs starting with /static/ from the root (e.g., ```
``` or ``````). These paths are ignored by the plugin's rewriting logic and remain unchanged in the output HTML. If you need to store static files under /static/, ensure they are served correctly by your server or build setup, as they won't be bundled or optimized by vite-plugin-html.
+
+For example:
+Use ```
``` and place the file with directory img/example.jpg in the static/ directory if you want that it and served directly.
+
## Parameter Description
`createHtmlPlugin(options: UserOptions)`