docs: basic

vclemenzi · Mar 20, 2024 · 92e6759 · 92e6759
1 parent ef88348
commit 92e6759
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 0 deletions.
diff --git a/.npmignore b/.npmignore
@@ -1,5 +1,6 @@
 src/
 examples/
+docs/
 .gitignore
 .prettierignore
 .prettierrc
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,4 @@
+# vite-plugin-multip docs
+Documentation of the plugin (web version in arrtive) vite-plugin-multip
+
+- [custom html](https://github.com/vclemenzi/vite-plugin-multip/blob/main/docs/custom-html.md)
diff --git a/docs/custom-html.md b/docs/custom-html.md
@@ -0,0 +1,28 @@
+# HTML Customization with vite-plugin-multip
+
+With the `vite-plugin-multip` plugin, you have the ability to fully customize the HTML structure using a custom HTML template.
+
+Configuration:
+```ts
+multipage({ customHtml: "path/to/your/template.html" })
+```
+
+Example of the custom HTML template:
+```html
+<!DOCTYPE HTML>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>My Custom HTML</title>
+  </head>
+  <body>
+    {% body %}
+  </body>
+</html>
+```
+
+`{% body %}` will be replaced with the content of the specific page's body. This feature allows you to completely tailor the appearance and structure of your multipage setup, offering greater flexibility in design.
+
+*You can find an example [here](https://github.com/vclemenzi/vite-plugin-multip/tree/main/examples/custom-html)*