@puckeditor/core 0.24.1-canary.f0a3f91c → 0.25.0-canary.1282e96b
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 +34 -1
- package/package.json +3 -1
package/README.md
CHANGED
|
@@ -82,6 +82,34 @@ export function Page() {
|
|
|
82
82
|
}
|
|
83
83
|
```
|
|
84
84
|
|
|
85
|
+
## CLI
|
|
86
|
+
|
|
87
|
+
Set up Puck and Puck Cloud in a new or existing Next.js, React Router, TanStack Start, vinext, Vite or Astro app, or a Hono or Express server. Built for coding agents, friendly for humans:
|
|
88
|
+
|
|
89
|
+
```sh
|
|
90
|
+
npx @puckeditor/cli init
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
See the [CLI docs](https://puckeditor.com/docs/cli) for agent usage.
|
|
94
|
+
|
|
95
|
+
## For agents
|
|
96
|
+
|
|
97
|
+
Puck is built to be set up and used by coding agents as well as people. The CLI sets up Puck without prompting, and ships with the docs for its release, so agents can read the docs for the version a project uses:
|
|
98
|
+
|
|
99
|
+
```sh
|
|
100
|
+
npx @puckeditor/cli init --yes --json
|
|
101
|
+
npx @puckeditor/cli docs find "dynamic fields"
|
|
102
|
+
npx @puckeditor/cli docs cat api-reference/fields/text
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Agents with skill support can install the [Puck skill](https://github.com/puckeditor/skills):
|
|
106
|
+
|
|
107
|
+
```sh
|
|
108
|
+
npx skills add puckeditor/skills --skill puck
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
The latest docs are indexed at [llms.txt](https://puckeditor.com/llms.txt), and any page is available as markdown by adding `.md` to its URL.
|
|
112
|
+
|
|
85
113
|
## Recipes
|
|
86
114
|
|
|
87
115
|
Use `create-puck-app` to quickly spin up a a pre-configured app based on our provided [recipes](https://github.com/puckeditor/puck/tree/main/recipes):
|
|
@@ -93,7 +121,12 @@ npx create-puck-app my-app
|
|
|
93
121
|
Available recipes include:
|
|
94
122
|
|
|
95
123
|
- [**next**](https://github.com/puckeditor/puck/tree/main/recipes/next): Next.js example, using App Router and static page generation
|
|
96
|
-
- [**react-router**](https://github.com/puckeditor/puck/tree/main/recipes/react-router): React Router
|
|
124
|
+
- [**react-router**](https://github.com/puckeditor/puck/tree/main/recipes/react-router): React Router v8 app example, using dynamic routes to create pages at any level
|
|
125
|
+
- [**tanstack-start**](https://github.com/puckeditor/puck/tree/main/recipes/tanstack-start): [TanStack Start](https://tanstack.com/start) example, using a splat route and server functions to create pages at any level
|
|
126
|
+
- [**hono**](https://github.com/puckeditor/puck/tree/main/recipes/hono) and [**express**](https://github.com/puckeditor/puck/tree/main/recipes/express): Hono and Express servers exposing a pages API, and Puck AI in the `-ai` variants, for an editor in another app
|
|
127
|
+
- [**astro**](https://github.com/puckeditor/puck/tree/main/recipes/astro): Astro example, rendering Puck pages on the server with the Node adapter
|
|
128
|
+
- [**vite**](https://github.com/puckeditor/puck/tree/main/recipes/vite): Vite React app example, with a small Hono server for pages
|
|
129
|
+
- [**vinext**](https://github.com/puckeditor/puck/tree/main/recipes/vinext): [vinext](https://github.com/cloudflare/vinext) example, running the Next.js App Router on Vite
|
|
97
130
|
|
|
98
131
|
## Community
|
|
99
132
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@puckeditor/core",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.25.0-canary.1282e96b",
|
|
4
4
|
"description": "The open-source visual editor for React",
|
|
5
5
|
"author": "Chris Villa <chris@puckeditor.com>",
|
|
6
6
|
"repository": {
|
|
@@ -94,6 +94,8 @@
|
|
|
94
94
|
"lucide-react": "^0.468.0",
|
|
95
95
|
"postcss": "^8.5.6",
|
|
96
96
|
"postcss-modules": "^6.0.1",
|
|
97
|
+
"react": "^19.2.1",
|
|
98
|
+
"react-dom": "^19.2.1",
|
|
97
99
|
"ts-jest": "^29.3.4",
|
|
98
100
|
"ts-node": "^10.9.2",
|
|
99
101
|
"tsconfig": "0.0.0",
|