Puck Pages
Puck Pages is experimental and may change in a future release.
Puck Pages is a database for your pages, making it easy to spin up a new project with Puck.
It provides:
- A database for Puck page data
- A plugin for browsing, creating, saving and publishing pages
- Version history
- Data migrations (coming soon)
Plugin
The Pages plugin lets you browse, create, save and publish pages inside Puck Editor. Set up Puck Pages
Server APIs
Puck Pages provides server APIs for managing pages from your backend. Use this to build custom page dashboards or manage them programmatically.
| API | Description | Returns |
|---|---|---|
pages.create() | Create a page | Page |
pages.get() | Get the latest version of a page, or a specific version | Page |
pages.getByPath() | Get the page at a path, at its latest or a specific version | Page | null |
pages.getPublished() | Get the published version of the page at a path | Page | null |
pages.list() | List all pages | PageList |
pages.update() | Change a page’s path | Page |
pages.delete() | Delete a page, and all its versions | { id, deleted: true } |
pages.createVersion() | Create a new version of a page | Page |
pages.listVersions() | List all versions of a page | PageList |
pages.publish() | Publish a version of a page, and unpublish the others | Page |
pages.unpublish() | Unpublish a page | Page |
Guides
| Guide | Description |
|---|---|
| Set up Puck Pages | Set up the Pages plugin to manage pages inside Puck |