docs: update doc meta (#1790)

Co-authored-by: Daniel Roe <[email protected]>
nuxt · Nov 10, 2021 · 9b9843b · 9b9843b
1 parent 02f3fd1
commit 9b9843b
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/packages/kit/src/config/schema/_app.ts b/packages/kit/src/config/schema/_app.ts
@@ -111,6 +111,28 @@ export default {
   /**
    * Set default configuration for `<head>` on every page.
    *
+   * @example
+   * ```js
+   * meta: {
+   *  meta: [
+   *    // <meta name="viewport" content="width=device-width, initial-scale=1">
+   *    { name: 'viewport', content: 'width=device-width, initial-scale=1' }
+   *  ],
+   *  script: [
+   *    // <script src="https://myawesome-lib.js"></script>
+   *    { src: 'https://awesome-lib.js' }
+   *  ],
+   *  link: [
+   *    // <link rel="stylesheet" href="https://myawesome-lib.css">
+   *    { rel: 'stylesheet', href: 'https://awesome-lib.css' }
+   *  ],
+   *  // please note that this is an area that is likely to change
+   *  style: [
+   *    // <style type="text/css">:root { color: red }</style>
+   *    { children: ':root { color: red }', type: 'text/css' }
+   *  ]
+   * }
+   * ```
    * @version 3
    */
   meta: {