1.0.2 • Published 5 years ago

@gatsby-themes/core v1.0.2

Weekly downloads
7
License
MIT
Repository
github
Last release
5 years ago

Gatsby Core Theme

The core theme sets up the base configuration.

  • The idea is to have the SEO, image processing, file source setup , PWA, core branding of the product in one place and versioned
  • Sites can simply use the not worry about setting this piece properly and any changes to the core configuration can be done via the theme.
  • All organization specific core plugins , icons can be configured here.

How to use

  • Add the dependency @gatsby-themes/core
  • The core theme will warn of the peer dependencies which also must be added to the gatsby site leveraging this theme.
  • The dependencies include - "gatsby": "^2.13.21",
    • "gatsby-image": "^2.2.6",
    • "gatsby-plugin-manifest": "^2.2.0",
    • "gatsby-plugin-offline": "^2.2.0",
    • "gatsby-plugin-react-helmet": "^3.1.0",
    • "gatsby-plugin-sharp": "^2.2.1",
    • "gatsby-source-filesystem": "^2.1.0",
    • "gatsby-transformer-sharp": "^2.2.0",
yarn add `@gatsby-themes/core`
  • Configure the theme in the gatsby-config.js file.
const config = require('./data/siteConfig.js')

module.exports = {
	plugins: [
		{
			resolve: '@gatsby-themes/core',
			options: {
				siteMetadata: {
					title: config.siteTitle,
					description: config.siteDescription,
				},
				pathPrefix: config.pathPrefix,
			},
		},
	],
}
  • Add the site configuration file in the project data/siteConfig.js
module.exports = {
	siteTitle: '<replace with title>',
	siteDescription: '<replace with description>',
	author: '<replace with author name>',
	pathPrefix: '/',
}