Skip to main contentGatsby theme Carbon

Configuration

Gatsby themes allow you to override configuration from the theme by defining the same property in your gatsby-config.js at the root of your project. You can see the default configuration provided by the theme’s gatsby-config.js file.

Site metadata

To add a title and description to each page, simply provide them to siteMetadata in your gatsby-config.js file.

The language attribute applied to the <html> tag on every page is English (en) by default, but you can choose to override this. For more information on declaring the language of a page in HTML, please review W3 Criterion 3.1.1 Language of a Page.

module.exports = {
  siteMetadata: {
    title: 'Gatsby Theme Carbon',
    description: 'A Gatsby theme for the carbon design system',
    keywords: 'gatsby,theme,carbon',
    lang: 'en',
  },
  plugins: ['gatsby-theme-carbon'],
};

Manifest

One of the first configurations should be to override the default manifest options, you can do this in gatsby-config.js. Any options you don’t set, will be provided by the theme. See the example project.

siteMetadata: {
    title: 'Gatsby Theme Carbon',
  },
  plugins: [
    'gatsby-theme-carbon',
    {
      resolve: 'gatsby-plugin-manifest',
      options: {
        name: 'Carbon Design Gatsby Theme',

Favicon

If you need to override the default favicon, you can do so by passing a relative path to the icon. It’s recommended to provide a 512 x 512 version.

IMPORTANT: For best results, if you’re providing an icon for generation it should be…

  • at least as big as the largest icon being generated (512x512 by default).
  • square (if it’s not, transparent bars will add to make it square).
  • of one of the follow formats: JPEG, PNG, WebP, TIFF, GIF or SVG.
plugins: [
    {
      resolve: 'gatsby-theme-carbon',
      options: {
        iconPath: './src/images/custom-icon-512.png'
      },
    },
  ],

Additional font weights

If needed, you can add support for additional Plex font weights. Don’t forget to specify italics for the additional weights if needed.

plugins: [
    {
      resolve: 'gatsby-theme-carbon',
      options: {
        // will get added to default [300, 400, 600]
        additionalFontWeights: ['200', '200i]
      },
    },
  ],

Image compression

You can enable WebP by passing withWebp: true or providing your own optimization level. See the gatsby-remark-images plugin options. You can also tweak the image quality based on design tolerance and performance thresholds.

module.exports = {
  plugins: [
    {
      resolve: 'gatsby-theme-carbon',
      options: {
        withWebp: true, // true, false (default false)
        imageQuality: 50, // 0-100 (default 75)
      },
    },

Global search

Site-wide search is provided by the theme. The only requirement for a page to show up in the results is for it to have title set in the frontmatter. To render more helpful search results (and improve SEO), you’ll want to make sure your pages have description set in the frontmatter as well.

Global search is enabled by default. To disable it, set the isSearchEnabled option to false.

  plugins: [
    {
      resolve: 'gatsby-theme-carbon',
      options: {
        isSearchEnabled: false
      },
    },
  ],

Under the hood, we use Lunr to create our search index. If necessary, you tweak the search scoring algorithm and source nodes. To do so, provide your own resolvers object to the lunrOptions theme option.

Edit on GitHub link

To add a link to the bottom of each page that points to the current page source in GitHub, provide a repository object to siteMetadata in your gatsby-config.js file. You can provide a baseUrl, and if needed, the subDirectory and branch where your site source lives.

To disable the Edit in Github link, remove the repository option. If the options object is now empty, delete it all together.

  plugins: [
    {
      resolve: 'gatsby-theme-carbon',
      options: {
        repository: {
          baseUrl: 'https://github.com/carbon-design-system/gatsby-theme-carbon',
          subDirectory: '/packages/example',
          branch: 'master',
        },

Medium

In order to change the source account for the MediumPosts component, provide an account with the mediumAccount option.

plugins: [
  {
    resolve: 'gatsby-theme-carbon',
    options: {
      mediumAccount: 'carbondesign',
    },
  },
];

Other options

  • additionalFontWeights – add support for additional Plex font weights. Don’t forget to specify italics for the additional weights if needed.

  • mdxExtensions – change the file extensions processed by gatsby-mdx (default [‘.mdx’, ‘.md’]).

  • pngCompressionSpeed - a speed/quality trade-off from 1 (brute-force) to 10 (fastest). Speed 10 has 5% lower quality, but is 8 times faster than the default (4).

  • titleType – pick between four formats for the <title> element for your site. Here are the four options using this page as an example:

    • page: “Configuration” (default)
    • site: “Gatsby Theme Carbon”
    • append: “Gatsby Theme Carbon – Configuration”
    • prepend: “Configuration - Gatsby Theme Carbon”
plugins: [
    {
      resolve: 'gatsby-theme-carbon',
      options: {
        additionalFontWeights: ['200', '200i'],
        mdxExtensions: ['.mdx'],
        titleType: 'append'
      },
    },

Additional remark plugins and override existing remark plugin configuration

  • gatsbyRemarkPlugins - An array containing gatsby remark plugin configurations to be added/overridden.

Example Gatsby Remark Mermaid plugin

For the below markdown snippet:

```mermaid
graph LR
install[Install Plugin]
install --> configure[Configure Plugin]
configure --> draw[Draw Fancy Diagrams]
```

to turn into an image one should add the following configuration to her/his own project:

 plugins: [
    {
      resolve: 'gatsby-theme-carbon',
      options: {
        repository: {
          baseUrl: 'https://github.com/carbon-design-system/gatsby-theme-carbon',
          subDirectory: '/packages/example',
          branch: 'master',
        },
Edit this page on GitHub
Previous
Contributions
Next
Guides: Authoring MDX