damassi / gatsby-starter-typescript-rebass-netlifycms

My default Gatsby setup. Includes rich MDX support.

Barebones Gatsby Starter

• TypeScript
• Styled Components
• Rebass
• MDX
• Jest
• NetlifyCMS, with local file-system and MDX support
• Lint Staged
• Prettier

This starter was extracted from an earlier iteration I completed while working on Palette, Artsy's design system. Check out the docs site for a more full-featured example (including some interesting live-coding capabilities) or the source-code.

Development

yarn start
yarn clean
yarn type-check

Please note that Yarn is required, as NPM may not install dependencies correctly, causing issues for development.

Deployment

yarn build

Demo

GraphQL Validation

Validation has been added via eslint-plugin-graphql:

TODO: Figure out how to generate usable types for TypeScript with apollo-cli.

Gatsby API Details

1. gatsby-browser.js: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser.
2. gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).
3. gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.
4. gatsby-ssr.js: This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering.