gatsby-starter-typescript-rebass-netlifycms

KO | EN

gitlite — search

#python #blockchain #java #android #javascript #database #angular #cli #r #kali #kali-linux #ontology

gatsby-starter-typescript-rebass-netlifycms

★ 83 Open GitHub ↗

My default Gatsby setup. Includes rich MDX support.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Barebones Gatsby Starter

- [TypeScript](https://www.typescriptlang.org/)
- [Styled Components](https://www.styled-components.com/)
- [Rebass](https://github.com/rebassjs/rebass)
- [MDX](https://mdxjs.com/)
- [Jest](https://jestjs.io/)
- [NetlifyCMS](https://www.netlifycms.org/), with local file-system and MDX
  support
- [Lint Staged](https://github.com/okonet/lint-staged)
- [Prettier](https://prettier.io/)

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

### Development

```sh
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

```sh
yarn build
```

### Demo

![demo](https://user-images.githubusercontent.com/236943/51792565-abd93e00-2167-11e9-8bcb-87f7dccece52.gif)

### GraphQL Validation

Validation has been added via `eslint-plugin-graphql`:

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

<details>
  <summary>Gatsby API Details</summary>

1.  **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage
    of the [Gatsby browser APIs](https://www.gatsbyjs.org/docs/browser-apis/)
    (if any). These allow customization/extension of default Gatsby settings
    affecting the browser.
1.  **`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](https://www.gatsbyjs.org/docs/gatsby-config/) for more
    detail).
1.  **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of
    the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/node-apis/) (if any).
    These allow customization/extension of default Gatsby settings affecting
    pieces of the site build process.
1.  **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of
    the
    [Gatsby server-side rendering APIs](https://www.gatsbyjs.org/docs/ssr-apis/)
    (if any). These allow customization of default Gatsby settings affecting
    server-side rendering.

</details>

gatsby-starter-typescript-rebass-netlifycms

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README