docs: add "head" config to app-configs (#1011)

Co-authored-by: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
2 years ago · 424c882a6d
parent 0006cb67ec
commit 424c882a6d
1 changed files with 22 additions and 0 deletions
--- a/docs/config/app-configs.md
+++ b/docs/config/app-configs.md
@ -55,6 +55,28 @@ export default {
 }
 ```

+## head
+
+- Type: `HeadConfig[]`
+- Default: `[]`
+
+Additional elements to render in the `<head>` tag in the page HTML. The user-added tags are rendered before the closing `head` tag, after VitePress tags.
+
+```ts
+export default {
+  head: [
+    ['link', { rel: 'preconnect', href: 'https://fonts.gstatic.com', crossorigin: '' }]
+    // would render: <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
+  ]
+}
+```
+
+```ts
+type HeadConfig =
+  | [string, Record<string, string>]
+  | [string, Record<string, string>, string]
+```
+
 ## ignoreDeadLinks

 - Type: `boolean`