Git Product home page Git Product logo

gatsby-starter-material-ui's Introduction

Gatsby Material-UI Starter

Screenshot

Starter template for Gatsby using Material-UI (based on Gatsby default starter. See live demo here.

For an overview of the project structure please refer to the Gatsby documentation - Building with Components.

The Material-UI theme is configured in src/getPageContext.js. This theme is propagated down a component tree using the withRoot HOC (see src/withRoot.js). Consequently, top-level components should be wrapped with this HOC. This will ensure that the theme is available to all the nested components. In this starter template, I have wrapped the Layout component with withRoot - it is the root component used by all pages.

Additionally, if you create your own JSS styles in a component, you need to wrap it with the withStyles HOC in order to pass your custom styles down (e.g. src/components/layout.js).

I have also provided a way to create global styles (see src/styles/styles.css). This allows you to style simple HTML markup, e.g. markup generated by Markdown. An alternate way to do this is using gatsby-plugin-typography.

Prerequisites

Make sure that you have the Gatsby CLI program installed:

npm install --global gatsby-cli

Dev Build

$ yarn
$ yarn develop

Now point your browser to http://localhost:8000.

Production Build

$ yarn build
$ yarn serve

Now point your browser to http://localhost:9000 and test the production build locally. When you are happy with it, deploy the public folder to your production web server.

Formatting JavaScript Code

$ yarn format

gatsby-starter-material-ui's People

Contributors

nareshbhatia avatar noccer avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.