Learn how to use Prismic with Nuxt.
Prismic is a headless website builder. With a traditional CMS, you can manage a website's text and images. With Prismic, you can also manage website components — so teams can build their entire website with Prismic.
Prismic works with Nuxt, a web framework for Vue. See how to create a new Prismic project with Nuxt in the Set up Prismic guide, or read on to learn Prismic basics.
Highlights of Prismic
Here are a few key Prismic features that will help you understand how Prismic works.
- Slices: Building blocks for websites (like website components, but for content)
- Slice Machine: The local development tool to configure Prismic
- Editor: The Prismic app where writers create content
To try Prismic yourself, follow along with the blue boxes:
Your Turn: Try Prismic now
Learn what Prismic is with a hands-on demo.
Run this command in your terminal to get started with a demo Nuxt app.
npx degit https://github.com/prismicio-community/crash-course-nuxt crash-course-nuxt cd crash-course-nuxt npx @slicemachine/init
With this command, you’ll get a fully-featured Prismic website to test out.
You’ll be asked to log in with a Prismic account and name a new Prismic content repository. Go ahead and name the repository anything you want.
Once the app is created, navigate into the app directory and start it up.
npm run dev
You’ll be able to see the live site running at http://localhost:3000
Next, we'll explain each of these three features.
Slices are Prismic’s star feature. They are sections of a page you can reuse as many times as you need — each time with new content. Slices bring the component-based workflow to the content editor. You (and your content team) are really going to love them.
To visualize what Slices are, imagine breaking up (or “slicing” up 😉) a webpage into different sections. Some examples:
- Image with Text
- Signup Form
- Call to Action
As a Nuxt dev, you would typically create these sections as components. But imagine you could use these components in your content management system.
Guess what!? That's what Slices do.
You render your Slices with Prismic's <SliceZone> component. The <SliceZone> component requires two props:
- the Slice array from the API
- a collection of Vue components corresponding to each Slice type
The <SliceZone> component can render your entire page with just these two props.
Just like that ✨ you have a robust website builder for developers and content writers alike.
Your turn: Find your Slices
Your demo app includes Slices for text, images, and product features. Look at the following files in your text editor to see how everything is hooked up:
- slices/ImageAndText/index.vue: The Vue component for the Image and Text Slice
- slices/index.js: The full collection of Vue components, one for each Slice
- pages/_uid.vue: The app’s homepage, with a <SliceZone> to render Slices
Slices are created using a local development tool called Slice Machine. Let’s go over that next.
Slice Machine is the local development tool to build Slices. Like most development tools, you run it from your terminal.
When you create a Slice in Slice Machine, Slice Machine will generate the file structure for the Slice.
You build the Slice by adding Fields. A Field stores a piece of data, like an image, a number, or text. For each Field, Slice Machine will provide a code snippet to template the Field in the React component.
As you develop your Slice, you can simulate what the Slice will look like in Slice Machine. Keep Slice Machine open in another window while you code so you can see your changes live as you save.
When you're happy with your Slice, you can push the Slice and a screenshot of it to the Prismic Editor so that your content team can use the Slice in the Editor.
In addition to Slices, you use Slice Machine to create Custom Types. Custom Types are types of documents in your app, such as Pages and Authors.
If a Slice represents a section of a webpage, a Custom Type represents the webpage itself.
Your turn: Run Slice Machine
Your demo app includes Slice Machine. After running npm run dev, Slice Machine is available at http://localhost:9999
Check out the following screens in Slice Machine to see how everything is configured:
- In the Slices tab, see each Slice with all of its fields
- When viewing a Slice, click on the Simulate Slice button to see the Slice simulation in action.
- In the Custom Types tab, see each Custom Type with all of its available Slices and fields
Slice Machine pushes your Slices and Custom Types up to the Editor for usage by your content team. Let's check out the Editor next.
The Editor is the app your content team uses to write content for the website. Prismic hosts the Editor for you.
While writing content, writers can click a button to see all available Slices. Screenshots from Slice Machine show writers what each Slice looks like.
Content writers can create, update, and delete documents, just like files on your computer. Everything is versioned so that content changes can be rolled back or restored.
Writers can preview content live on the website before publishing.
The Editor should feel familiar to most writers. Text formatting works just like in other word processors.
As a developer, you fetch the content that your writers create from the Prismic API using Prismic's development kits.
Your turn: Try the Editor
Check out the following screens in the Editor:
- Documents: Go into the Homepage document to see its fields and its Slices.
- Editing content: In the Homepage document, edit some content, add a Slice, and save. When you’re ready, go ahead and publish it. You’ll see your updates in the demo app’s http://localhost:3000 webpage.
- Media Library: Click the Media Library icon (a photo of mountains) in the left sidebar to see where images and files can be uploaded.
The Editor is designed for content writers to focus on what’s important: writing content.
Now that you know the basics of Prismic, you're ready to dive in and start building!
To start your project from scratch with a new setup, proceed to the Install step.
Was this article helpful?
Can't find what you're looking for? Spot an error in the documentation? Get in touch with us on our Community Forum or using the feedback form above.