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

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.
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).
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.
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.

Error editing MDX docs

Clone repo
npm i
npm run develop
Browse to http://localhost:8000/admin/#/collections/mdx/entries/hello
Following error received:

Error
There's been an error - please report it.

Details
Invariant Violation: Minified React error #130; visit https://reactjs.org/docs/error-decoder.html?invariant=130&args[]=undefined&args[]= for the full message or use the non-minified dev environment for full errors and additional helpful warnings.

Markdown docs work fine. All the MDX docs display the error.

Gatsby info:


  System:
    OS: macOS 10.14
    CPU: (4) x64 Intel(R) Core(TM) i5-7360U CPU @ 2.30GHz
    Shell: 3.2.57 - /bin/bash
  Binaries:
    Node: 8.12.0 - /usr/local/bin/node
    npm: 6.4.1 - /usr/local/bin/npm
  Languages:
    Python: 2.7.10 - /usr/bin/python
  Browsers:
    Chrome: 76.0.3809.100
    Firefox: 61.0.2
    Safari: 12.0
  npmPackages:
    gatsby: ^2.0.76 => 2.13.72 
    gatsby-image: ^2.0.20 => 2.2.10 
    gatsby-mdx: ^0.3.4 => 0.3.6 
    gatsby-plugin-catch-links: ^2.0.9 => 2.1.4 
    gatsby-plugin-manifest: ^2.0.9 => 2.2.6 
    gatsby-plugin-netlify-cms: ^3.0.10 => 3.0.18 
    gatsby-plugin-offline: ^2.0.16 => 2.2.7 
    gatsby-plugin-sharp: ^2.0.14 => 2.2.13 
    gatsby-plugin-styled-components: ^3.0.4 => 3.1.2 
    gatsby-plugin-typescript: ^2.0.3 => 2.1.3 
    gatsby-source-filesystem: ^2.0.16 => 2.1.10 
    gatsby-transformer-sharp: ^2.1.8 => 2.2.7 
  npmGlobalPackages:
    gatsby-cli: 2.7.8

damassi / gatsby-starter-typescript-rebass-netlifycms Goto Github PK

gatsby-starter-typescript-rebass-netlifycms's Introduction

Barebones Gatsby Starter

Development

Deployment

Demo

GraphQL Validation

gatsby-starter-typescript-rebass-netlifycms's People

Contributors

Stargazers

Watchers

Forkers

gatsby-starter-typescript-rebass-netlifycms's Issues

Error editing MDX docs

Gatsby info:

[Question] Best practice for creating and defining a Button component

Error on gatsby serve

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent