See the live demo

GatsbyJS is a free and open source static website builder build on React. It's one implementation of the JAMstack idea which creates high speed webpages.

📚 Features:

• Landingpage
• Blog overview page
• Markdown sourcing from /content folder
• Estimated reading time for each post
• Netlify deployment friendly
• Styled components with emotion
• Syntax highlighting with prismjs
• Textmarkerstyle headings inspired by Basecamp
• Site meta tags with React Helmet
• Nunito font included as npm module
• Plugins for offline support

Installation

To use this theme in your Gatsby sites, follow these instructions:

1. Install the theme

   npm install --save gatsby-theme-yoyo

2. Add the theme to your gatsby-config.js:

   module.exports = {
     plugins: [
       'gatsby-theme-yoyo'
     ]
   }

3. Start your site

   gatsby develop

👨🏻‍💻 Customization

Create new pages like an About page in the /pages directory. The minimum code is:

import React from "react"

import Layout from "../components/layout"
import SEO from "../components/seo"

const PageName = () => (
  <Layout>
    <SEO title="PageName" keywords={[`gatsby`, `application`, `react`]} />
    //CONTENT HERE
  </Layout>
)

export default PageName

To change the name on the landing page please modify the title in gatsby-config.js

The Nunito typeface is included as a npm module in gatsby-browser.js and in /components/layout.css

This Gatsby theme is built on top of the official gatsby-starter-default. You can find a quick start guide in the following lines. There are the most important files explained.

🧐 What's inside?

A quick look at the top-level files and directories you'll see in a Gatsby project.

.
├── node_modules
├── src
├── .gitignore
├── .prettierrc
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package-lock.json
├── package.json
└── README.md

1. /node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

2. /src: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. src is a convention for “source code”. A short description of what you can find there is below.👨🏻‍💻

3. .gitignore: This file tells git which files it should not track / not maintain a version history for.

4. .prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent.

5. 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. For example is the Nunito typeface imported here.

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

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

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

9. LICENSE: Gatsby is licensed under the MIT license.

10. package-lock.json (See package.json below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).

11. package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.

12. README.md: A text file containing useful reference information about your project.

The src directory

.
├── components
├── content
├── images
├── pages
└── templates

1. /components: Your React components can be defined here. You can include them from there in your pages.

2. /content: The filesystem plugin is configured to get the *.md files from here. These will be published on the /blog page.

3. /images: This directory is the home for your images that you can query via GraphQL since the filesystem plugin publish them there.

4. /pages: Here is where your pages like /blog, /about and also the 404 page lives. An example of the basic structure can be found above.

5. /templates: You will find the blog-post.js template there which defines how every blog-post page is structured.

🎓 Learning Gatsby

Looking for more guidance? The perfect place to learn more about GatsbyJS is the website. Here are some places to start:

• For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.

• To dive straight into code samples, head to our documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.