Carbon Next.js Documentation Template

This is a site template created with Next.js and Carbon Design System that is intended to build a documentation-style site as static assets.

It is built using:

• Next.js
• Carbon i.e @carbon/react
  • Adheres to Carbon v11
• MDX
• Velite (as a content layer between site code and content)

Getting Started

This template requires a minimum of Node v18.17.0 to be installed.

First install dependencies via:

npm ci

Then, run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

There are some built-in docs as well. When running the development server navigate to http://localhost:3000/docs to see them.

Building for production

To create a production version of your app:

npm run build

This will generate the static assets at the site in the out folder. You can then preview the production build via:

npm run serve

Then you can navigate to http://localhost:3000 to see the site.

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.