@scalar/nextjs-api-reference 0.3.62 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +32 -0
  2. package/README.md +25 -0
  3. package/package.json +3 -3
package/CHANGELOG.md CHANGED
@@ -1,5 +1,37 @@
1
1
  # @scalar/nextjs-api-reference
2
2
 
3
+ ## 0.4.1
4
+
5
+ ### Patch Changes
6
+
7
+ - e0fc110: chore: patch bump all package
8
+ - Updated dependencies [e0fc110]
9
+ - Updated dependencies [f0acc89]
10
+ - @scalar/api-reference@1.24.3
11
+
12
+ ## 0.4.0
13
+
14
+ ### Minor Changes
15
+
16
+ - 7f8ef74: chore: remove aliasing
17
+
18
+ ### Patch Changes
19
+
20
+ - 6fbb57e: feat: release all the packages
21
+ - 54e73aa: chore: updpate docs for next.js pages router
22
+ - Updated dependencies [7f8ef74]
23
+ - Updated dependencies [689677a]
24
+ - Updated dependencies [326dcfb]
25
+ - Updated dependencies [b4db5da]
26
+ - Updated dependencies [d54eb42]
27
+ - Updated dependencies [68eede9]
28
+ - Updated dependencies [96347a1]
29
+ - Updated dependencies [8494349]
30
+ - Updated dependencies [b38c7ed]
31
+ - Updated dependencies [6fbb57e]
32
+ - Updated dependencies [6d11a8a]
33
+ - @scalar/api-reference@1.24.0
34
+
3
35
  ## 0.3.62
4
36
 
5
37
  ### Patch Changes
package/README.md CHANGED
@@ -57,3 +57,28 @@ const config = {
57
57
  theme: 'purple',
58
58
  }
59
59
  ```
60
+
61
+ ## Pages router
62
+
63
+ If you are using the pages router, you can import the React component
64
+
65
+ ```bash
66
+ npm install @scalar/api-reference-react
67
+ ```
68
+
69
+ ```tsx
70
+ import { ApiReferenceReact } from '@scalar/api-reference-react'
71
+ import '@scalar/api-reference-react/style.css'
72
+
73
+ export default function References() {
74
+ return (
75
+ <ApiReferenceReact
76
+ configuration={{
77
+ spec: {
78
+ url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.json',
79
+ },
80
+ }}
81
+ />
82
+ )
83
+ }
84
+ ```
package/package.json CHANGED
@@ -18,7 +18,7 @@
18
18
  "openapi",
19
19
  "swagger"
20
20
  ],
21
- "version": "0.3.62",
21
+ "version": "0.4.1",
22
22
  "engines": {
23
23
  "node": ">=18"
24
24
  },
@@ -35,7 +35,7 @@
35
35
  ],
36
36
  "module": "./dist/index.js",
37
37
  "dependencies": {
38
- "@scalar/api-reference": "1.23.5"
38
+ "@scalar/api-reference": "1.24.3"
39
39
  },
40
40
  "devDependencies": {
41
41
  "@types/node": "^20.8.4",
@@ -47,7 +47,7 @@
47
47
  "react-dom": "^18.3.1",
48
48
  "vite": "^5.2.10",
49
49
  "vite-plugin-dts": "^3.6.3",
50
- "@scalar/api-reference": "1.23.5"
50
+ "@scalar/api-reference": "1.24.3"
51
51
  },
52
52
  "peerDependencies": {
53
53
  "next": "^13 || ^14",