@walltowall/gatsby-theme-ww-base
Gatsby theme providing a common set of plugins and configuration for Wall-to-Wall Gatsby websites.
The following Gatsby-specific files are included:
-
gatsby-config.js
: Includes all basic plugins. Check the file for comments. -
gatsby-browser.js
: Includes as-needed polyfills for cross-browser compatability. Resets browser styles. -
gatsby-ssr.js
: Resets browser styles.
Install
npm install --save @walltowall/gatsby-theme-ww-base
In addition to installing the theme, install all peer dependencies listed in
package.json
.
How to use
// In your gatsby-config.js
__experimentalThemes: [
{
resolve: '@walltowall/gatsby-theme-ww-base',
options: {
// Path to the project's root directory. This is required and should be
// set to `__dirname`.
root: __dirname,
// The site's title. This is required.
siteTitle: 'My New Site',
// The site's short title used for the site's manifest file. It should be
// 23 characters or less. This is required.
siteTitleShort: 'Site',
// The site's description used for SEO. This is required.
siteDescription: 'Description of the site.',
// The site's full production URL. This is required.
siteUrl: 'https://example.com',
// Specify your CSS-in-JS library. Supports 'styled-components' or
// 'emotion'. Default: styled-components.
stylingLibrary: 'styled-components',
// Set to true if deploying the site to Netlify. This will include
// Netlify-specific optimization plugins. Default: true.
withNetlify: true,
// Set to true to include gatsby-plugin-react-axe. Default: true.
withAxe: true,
},
},
]