polen 0.9.0-next.7 → 0.9.0
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.
- package/README.md +28 -8
- package/package.json +9 -6
package/README.md
CHANGED
|
@@ -31,19 +31,39 @@ npm add polen
|
|
|
31
31
|
node build/app.js
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
##
|
|
34
|
+
## Live Demos
|
|
35
|
+
|
|
36
|
+
Experience Polen in action with our live documentation sites:
|
|
37
|
+
|
|
38
|
+
### 🌐 [View All Demos](https://the-guild-org.github.io/polen/)
|
|
39
|
+
|
|
40
|
+
Featured examples:
|
|
41
|
+
|
|
42
|
+
- **[Pokemon GraphQL API](https://the-guild-org.github.io/polen/latest/pokemon/)** - Explore a fun GraphQL API with rich schema documentation
|
|
43
|
+
- **GitHub GraphQL API** (Coming soon) - Browse GitHub's extensive GraphQL API documentation
|
|
35
44
|
|
|
36
|
-
|
|
45
|
+
### Demo Versions
|
|
37
46
|
|
|
38
|
-
|
|
47
|
+
Our demos are available at different stability levels, matching npm's dist tags:
|
|
39
48
|
|
|
40
|
-
|
|
49
|
+
- **Stable Release** (`latest`): [/polen/latest/pokemon](https://the-guild-org.github.io/polen/latest/pokemon/)
|
|
50
|
+
- The most recent stable version (e.g., `1.0.0`)
|
|
51
|
+
- Same as `npm install polen`
|
|
41
52
|
|
|
42
|
-
-
|
|
43
|
-
-
|
|
53
|
+
- **Pre-release** (`next`): [/polen/next/pokemon](https://the-guild-org.github.io/polen/next/pokemon/)
|
|
54
|
+
- The latest pre-release version (e.g., `1.1.0-beta.1`)
|
|
55
|
+
- Same as `npm install polen@next`
|
|
56
|
+
|
|
57
|
+
- **Tagged Versions**: Access any specific release
|
|
58
|
+
- e.g., [/polen/1.0.0/pokemon](https://the-guild-org.github.io/polen/1.0.0/pokemon/)
|
|
59
|
+
- Same as `npm install polen@1.0.0`
|
|
60
|
+
|
|
61
|
+
> [!TIP]
|
|
62
|
+
> The correspondence between demo URLs and npm versions makes it easy to test features before upgrading. If you're using `polen@1.0.0`, visit `/polen/1.0.0/pokemon` to see exactly how your docs will look!
|
|
63
|
+
|
|
64
|
+
## Examples
|
|
44
65
|
|
|
45
|
-
|
|
46
|
-
> These examples work against the version of Polen on trunk. Every commit on trunk is available as a pre-release on npm. You may see behaviour in the examples that has not been released in a stable version of Polen yet.
|
|
66
|
+
Find the source code for these demos and more in the [examples](./examples) directory.
|
|
47
67
|
|
|
48
68
|
## Guide
|
|
49
69
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "polen",
|
|
3
|
-
"version": "0.9.0
|
|
3
|
+
"version": "0.9.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "A framework for delightful GraphQL developer portals",
|
|
6
6
|
"author": {
|
|
@@ -29,11 +29,6 @@
|
|
|
29
29
|
"name": "node",
|
|
30
30
|
"version": ">=24.0.0",
|
|
31
31
|
"onFail": "error"
|
|
32
|
-
},
|
|
33
|
-
"packageManager": {
|
|
34
|
-
"name": "pnpm",
|
|
35
|
-
"version": ">=10.0.0",
|
|
36
|
-
"onFail": "error"
|
|
37
32
|
}
|
|
38
33
|
},
|
|
39
34
|
"imports": {
|
|
@@ -131,9 +126,16 @@
|
|
|
131
126
|
"zx": "8.5.5"
|
|
132
127
|
},
|
|
133
128
|
"devDependencies": {
|
|
129
|
+
"@actions/core": "^1.11.1",
|
|
130
|
+
"@actions/exec": "^1.1.1",
|
|
131
|
+
"@actions/github": "^6.0.1",
|
|
132
|
+
"@actions/glob": "^0.5.0",
|
|
133
|
+
"@actions/io": "^1.1.3",
|
|
134
134
|
"@changesets/cli": "^2.29.4",
|
|
135
135
|
"@eslint/js": "^9.28.0",
|
|
136
136
|
"@molt/command": "^0.9.0",
|
|
137
|
+
"@octokit/core": "^7.0.2",
|
|
138
|
+
"@octokit/types": "^14.1.0",
|
|
137
139
|
"@playwright/browser-chromium": "^1.52.0",
|
|
138
140
|
"@stylistic/eslint-plugin": "^4.4.1",
|
|
139
141
|
"@tsconfig/node-lts": "^22.0.1",
|
|
@@ -158,6 +160,7 @@
|
|
|
158
160
|
"globals": "^16.2.0",
|
|
159
161
|
"playwright": "1.53.0-beta-1749221468000",
|
|
160
162
|
"publint": "^0.3.12",
|
|
163
|
+
"semver": "^7.7.2",
|
|
161
164
|
"strip-ansi": "^7.1.0",
|
|
162
165
|
"type-fest": "^4.41.0",
|
|
163
166
|
"typescript": "^5.8.3",
|