@scalar/api-reference 1.2.2 → 1.2.4

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @scalar/api-reference
 
+## 1.2.4
+
+### Patch Changes
+
+- c3b215f: chore: no pinned peer dependency versions
+- Updated dependencies [c3b215f]
+  - @scalar/use-keyboard-event@0.5.5
+  - @scalar/swagger-editor@0.7.9
+  - @scalar/use-codemirror@0.7.14
+  - @scalar/use-tooltip@0.5.6
+  - @scalar/api-client@0.7.33
+  - @scalar/use-toasts@0.5.8
+  - @scalar/use-modal@0.1.8
+  - @scalar/themes@0.4.2
+  - @scalar/use-clipboard@0.5.8
+
+## 1.2.3
+
+### Patch Changes
+
+- 55246e5: chore: rewrite all package.jsons (including their prod, dev and peer dependency requirements)
+- f2941f5: feat: add `metaData` to the configuration to pass meta tags (title, opengraph data …)
+- Updated dependencies [55246e5]
+  - @scalar/use-keyboard-event@0.5.4
+  - @scalar/swagger-editor@0.7.8
+  - @scalar/swagger-parser@0.5.11
+  - @scalar/use-codemirror@0.7.13
+  - @scalar/use-clipboard@0.5.7
+  - @scalar/use-tooltip@0.5.5
+  - @scalar/api-client@0.7.32
+  - @scalar/use-toasts@0.5.7
+  - @scalar/use-modal@0.1.7
+  - @scalar/themes@0.4.1
+
 ## 1.2.2
 
 ### Patch Changes

package/README.md

@@ -28,7 +28,7 @@ import { ApiReference } from '@scalar/api-reference'
 </template>
 ```
 
-You can even [mount the component in React](https://github.com/scalar/scalar/blob/main/projects/react/src/App.tsx).
+You can even [mount the component in React](https://github.com/scalar/scalar/blob/main/examples/react/src/App.tsx).
 
 ## Configuration
 
@@ -122,3 +122,21 @@ Key used with CNTRL/CMD to open the search modal (defaults to 'k' e.g. CMD+k)
 ```vue
 <ApiReference :configuration="{ searchHotKey: 'l'} />
 ```
+
+#### metaData?: object
+
+You can pass information to the config object to configure meta information out of the box.
+
+```vue
+<ApiReference :configuration="{
+  metaData: {
+        title: 'Page title',
+        description: 'My page page',
+        ogDescription: 'Still about my my page',
+        ogTitle: 'Page title',
+        ogImage: 'https://example.com/image.png',
+        twitterCard: 'summary_large_image',
+        //Add more...
+      }
+  } />
+```