Develop and work with Prismic Slices, locally.

Slice Machine

Quickstart

For the smoothest onboarding experience, go to Prismic, create an account, create a new repository, and choose a starter project. You will be guided through a full introduction to Slice Machine.

If you want to dive in without any guidance, follow these steps:

Create a Next.js or Nuxt app:

npx create-next-app@latest my-app

npx nuxi@latest init my-app

Open the folder:

cd my-app

Install dependencies:

npm i

Init Slice Machine:

npx @slicemachine/init

Open two terminals. In one terminal, run the web app:

npm run dev

In the other, run Slice Machine:

npm run slicemachine

Now you can use Slice Machine to create content models for your website. You will push your models to Prismic, where editors can use them to create content.

You will need to query content from the Prismic API to use it in your application. To learn how to use the Prismic API, visit the Prismic Documentation.

Documentation

To discover what's new on this package check out the changelog. For full documentation, visit the official Prismic documentation.

Contributing

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Prismic developer community!

Asking a question: Open a new topic on our community forum explaining what you want to achieve / your question. Our support team will get back to you shortly.

Reporting a bug: Open an issue explaining your application's setup and the bug you're encountering.

Suggesting an improvement: Open an issue explaining your improvement or feature so we can discuss and learn more.

Submitting code changes: For small fixes, feel free to open a PR with a description of your changes. For large changes, please first open an issue so we can discuss if and how the changes should be implemented.

License

   Copyright 2013-2021 Prismic <[email protected]> (https://prismic.io)

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.