docs(config): add head section with example

3 years ago · 7c56f0fd83
parent bed68f1341
commit 7c56f0fd83
1 changed files with 27 additions and 1 deletions
--- a/docs/config/app-configs.md
+++ b/docs/config/app-configs.md
@ -55,6 +55,33 @@ export default {
 }
 ```

+## head
+
+- Type: `[string, Record<string, string>]` or `[string, Record<string, string>, string]`
+- Default: `none`
+
+This will render entries in the `<head>` tag in the page HTML.
+
+```ts
+export default {
+ head: [
+    ['link', { rel: 'icon', href: '/logo.svg', type: 'image/svg+xml' }],
+    ['meta', { property: 'og:title', content: 'VitePress' }],
+ ]
+}
+```
+
+If needed this can also be used to include script tags.
+
+```ts
+export default {
+ head: [
+    [ 'script', { async: 'async', src: 'https://external-script' } ],
+    [ 'script', {}, `console.log('VitePress!')`] // inside script tag.
+ ]
+}
+```
+
 ## ignoreDeadLinks

 - Type: `boolean`
@ -172,4 +199,3 @@ export default {
  titleTemplate: 'Vite & Vue powered static site generator'
 }
 ```
-