docs(vanilla): Update README (#7)

Marinerer · Jan 22, 2025 · c5794d7 · c5794d7
1 parent c05b9aa
commit c5794d7
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/packages/vanilla/README.md b/packages/vanilla/README.md
@@ -41,9 +41,10 @@ vanilla(options: string | string[] | object)
 
 | Name            | Type                         | Default | Description                           |
 | --------------- | ---------------------------- | ------- | ------------------------------------- |
-| `include`       | `string\|string[]`           |         | The pattern of pages.                 |
+| `include`       | `string \| string[]`         |         | The pattern of pages.                 |
 | `exclude`       | `string[]`                   | `[]`    | The pattern of pages to exclude.      |
 | `base`          | `string`                     | `'src'` | The base directory of pages.          |
+| `suffix`        | `string \| string[]`         | `html`  | The suffix of page file.              |
 | `minify`        | `boolean`                    | `true`  | Whether to minify the HTML.           |
 | `transform`     | `Transform`                  |         | Transform the HTML.                   |
 | `inject`        | `{tags:HtmlTagDescriptor[]}` |         | Inject the HTML Tags.                 |

diff --git a/packages/vanilla/src/types.ts b/packages/vanilla/src/types.ts
@@ -4,6 +4,7 @@ import type { TerserOptions } from 'vite-plugin-minify-html'
 export interface PluginOptions {
 	/**
 	 * @description HTML file pattern
+	 * @default 'src\/**\/*.html'
 	 */
 	include?: string | string[]