An opinionated Gatsby v2 starter with React Context, styled-components, page transitions, scroll events with IntersectionObserver and a focus on accessibility and SEO. Made for state-of-the-art marketing sites.
You can access a demo of this starter online at gatsby-universal.netlify.com.
Features
-
🤩 Page Transitions, component-based (with no-js support) -
👮♂️ IntersectionObserver, component-based (with polyfill) -
🌿 React Context for global UI state, with SSR -
💅 styled-componentsv4 -
💯 Optimized with Google Lighthouse (including test) -
🔥 Code Splitting of CSS and JS (component based) -
🔪 Inline SVG support -
⚙️ One config file for site-wide settings -
💙 Most social + meta tags in one component -
🖼 All favicons generated, only one icon file needed -
🌐 Offline support -
📄 Manifest support -
🗺 Sitemap support -
📱 Generated media queries for easy use -
😎 Prettier for code style -
👷♂️ CircleCI support -
🐙 Schema JSONLD -
🔎 size-pluginto keep an eye on your bundle sizes -
👨🏫 ESLint (based oneslint-plugin-react)
Do you have suggestions or feedback? Open an issue!
Lighthouse scores (on Netlify)
Usage
# Installation with `gatsby-cli`
gatsby new my-site https://github.com/fabe/gatsby-universal
# Installation with `git clone`
git clone [email protected]:fabe/gatsby-universal.git my-site
cd my-site
yarn install
# To develop
yarn develop
# To build
yarn build
# To test SSR (for Lighthouse etc.)
yarn ssr
# To format JS (precommit)
yarn format
# To generate favicons (included in `build`)
yarn build:faviconsConfiguration
Find the site-wide configuration in site-config.js.
module.exports = {
siteTitle: `Gatsby Universal`,
siteTitleShort: `GatsbyU`,
siteDescription: `An opinionated starter for Gatsby.`,
siteUrl: `https://gu.fabianschultz.com`,
themeColor: `#000`,
backgroundColor: `#fff`,
pathPrefix: null,
logo: path.resolve(__dirname, 'src/images/icon.png'),
social: {
twitter: `gatsbyjs`,
fbAppId: `966242223397117`,
},
};
🚨 Don't forget to update yourrobots.txtinsidestatic/!
Folder structure
├── gatsby-browser.js # Specify how Gatsby renders pages in the browser
├── gatsby-config.js # Gatsby config, mostly taken from `site-config.js`
├── gatsby-node.js # Modify webpack config
├── gatsby-ssr.js # Specify how Gatsby builds pages
├── site-config.js # Global settings for the whole site, used by multiple scripts
├── content # Content & data, in both json and markdown
├── src
│ ├── components
│ │ ├── head # All meta tags etc.
│ │ ├── io # Intersection Observer component, uses render props
│ │ ├── layout # Layout component
│ │ │ ├── layout.css.js # .css.js for component's `styled-components`
│ │ │ └── layout.js
│ │ └── transition # Page Transition component, used by Gatsby APIs
│ ├── constants # Site-wide constants (breakpoints, colors, etc.)
│ ├── containers # Container components if store is needed
│ ├── helpers
│ │ ├── schemaGenerator.js # Generates JSON-LD schema.org snippets
│ │ └── mediaTemplates.js # Creates media queries for styled-components
│ ├── images # Images needed by the site/theme (not content)
│ ├── pages
│ ├── store # Store and provider of a React.createContext instance
│ └── global.css.js # Global CSS
└── scripts
├── lighthouse.test.js # Tests the site specified inside `site-config.js` with Google Lighthouse (WIP)
└── favicons.js # Generates favicons and manifest using one png only.Author
- Fabian Schultz (@fschultz_) - Stink Studios