This is a Next.js template utilizing Carbon for IBM.com React, deploying a vanilla instance of Next.js with the DotcomShell, along with other various patterns and components available in Carbon for IBM.com.
Get the code by cloning this repo using git
git clone https://github.com/carbon-design-system/carbon-for-ibm-dotcom-nextjs-template.gitOnce cloned, go to the project directory to install dependencies and build the project
$ yarn && yarn buildIn order to enable features like Right-to-Left (RTL), you will
have to set environment variables in a .env file. Please see .env.example.
BASE_PATH=<Sets the base directory for urls and assets, default is '' >
ALTLANG_ROOT_PATH=<Sets the root path for language alternative urls, default is '/' >
ENABLE_RTL=<Boolean to enable RTL for the page, eg. false >
SASS_PATH=node_modules:src
Then start the application:
$ yarn devTo export to a static site, run the following:
$ yarn build-exportThen the contents of the out folder can be uploaded to your production environment.
There may be times pathing errors are encountered when importing certain
stylesheets (like carbon-components). We're working hard to fix these, but in the meantime you can add
the following to your .env file to resolve:
SASS_PATH=node_modules:src
Note: For Windows, the syntax is slightly different
SASS_PATH=./node_modules;./src
Right-to-left rendering is supported, to enable set the ENABLE_RTL environment variable to true.
If building an IBM.com page, there are items that need to be included which can be viewed here: Building for IBM.com
This template handles page language functionality, where the available languages are defined in
components/data/altlang.json. The Altlangs component then generates all alternate links to be injected into the
<head> element.
The Digital Data Object (DDO) is a flexible, customizable collection of metadata that also provides tools and services such as live chat and analytics to page authors. You can find more details on Building for IBM.com.
The template has a placeholder DDO you can define located in `pages/data/DDO.json. Example values shown below:
<script>
digitalData = {
page: {
category: {
primaryCategory: '' // e.g. SB03
},
pageInfo: {
effectiveDate: '', // e.g. 2014-11-19
expiryDate: '', // e.g. 2017-11-19
language: '', // e.g. en-US
publishDate: '', // e.g. 2014-11-19
publisher: '', // e.g. IBM Corporation
version: 'Carbon for IBM.com',
ibm: {
contentDelivery: '', // e.g. ECM/Filegen
contentProducer: '', // e.g. ECM/IConS Adopter 34 - GS83J2343G3H3ERG - 11/19/2014 05:14:02 PM
country: '', // e.g. US
industry: '', // e.g. B,U
owner: '', // e.g. Some Person/City/IBM
siteID: '', // e.g. MySiteID
subject: '', // e.g. SW492
type: '' // e.g CT305
}
}
}
};
</script>The template already renders the required meta tags and IBM.com analytics script that are required for IBM.com websites.
They are located in pages/_app.js.These can be adjusted/removed to fit your project and needs.
Meta Tags:
<meta charset="UTF-8" />
<link rel="icon" href="//www.ibm.com/favicon.ico" />
<meta name="dcterms.date" content="YYYY-MM-DD" />
<meta name="dcterms.rights" content="© Copyright IBM Corp. 2016" />
<meta name="geo.country" content="US" />
<meta name="robots" content="index,follow" />IBM.com Tag Management and Site Analytics Script
<!-- IBM Tag Management and Site Analytics -->
<script src="//1.www.s81c.com/common/stats/ibm-common.js" defer></script>To pull latest changes from the Carbon for IBM.com NextJS template, this repo can be added as a remote to your application repository:
git remote add template https://github.com/carbon-design-system/carbon-for-ibm-dotcom-nextjs-template.gitThen run git fetch to update the changes:
git fetch --allAnd finally merge changes in:
git merge template/main