Skip to content

Commit

Permalink
Merge branch 'master' into patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
KyleAMathews authored Jan 2, 2018
2 parents 9068404 + 5efdc65 commit 7127b7c
Show file tree
Hide file tree
Showing 11 changed files with 41 additions and 22 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,15 @@ Websites built with Gatsby:
* [The State of European Tech 2017](https://2017.stateofeuropeantech.com)
* [Santa Compañía Creativa](https://santacc.es) ([source](https://github.com/DesarrolloWebSantaCC/santacc-web))
* [Pravdomil](https://pravdomil.com) ([source](https://github.com/pravdomil/pravdomil.com))
* [Fabian Schultz' Portfolio](https://fabianschultz.com)
([source](https://github.com/fabe/site))
* [Caddy smells like trees - Free-folk band official page](https://caddysmellsliketrees.ru)
([source](https://github.com/podabed/caddysmellsliketrees.github.io))
* [BRIIM](https://bri.im/)
* [KNW Photography](https://www.knw.io)
([source](https://github.com/ryanwiemer/knw))
* [NEON](http://neonrated.com)
* [manu.ninja](https://manu.ninja/) ([source](https://github.com/Lorti/manu.ninja))

## Docs

Expand Down
1 change: 1 addition & 0 deletions docs/docs/awesome-gatsby.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ A curated list of interesting Gatsby community projects and learning resources.
* [Giraffe Academy series on getting started with Gatsby](https://www.youtube.com/playlist?list=PLLAZ4kZ9dFpMXuwazIt4mWtTuqOHdjRlk)
* [Egghead course — "Build a Blog with React and Markdown using Gatsby"](https://egghead.io/courses/build-a-blog-with-react-and-markdown-using-gatsby)
* [Build a photo site with Gatsby — 6 part tutorial](https://jeremey.blog/gatsby-photo/)
* [Blazing fast website with Gatsby and Contentful series](https://www.youtube.com/watch?v=Ek4o40w1tH4&list=PL8KiuH6vpACV-F7jXribe4YveGBhBeG9A)
1 change: 0 additions & 1 deletion docs/docs/building-with-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@ import React, { Component } from "react";

class AboutPage extends Component {
render() {
const config = this.props.data.site.siteMetadata;
return (
<div className="about-container">
<p>About me.</p>
Expand Down
7 changes: 7 additions & 0 deletions docs/docs/create-source-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,3 +93,10 @@ But at a high-level, these are the jobs of a source plugin:
Gatsby when you're done sourcing nodes. Otherwise either Gatsby will continue
on before you're done sourcing or hang while waiting for you to indicate
you're finished.

[`gatsby-node-helpers`](https://github.com/angeloashmore/gatsby-node-helpers),
a community-made NPM package, can help when writing source plugins. This
package provides a set of helper functions to generate Node objects with the
required fields. This includes automatically generating fields like node IDs
and the `contentDigest` MD5 hash, keeping your code focused on data gathering,
not boilerplate.
6 changes: 3 additions & 3 deletions docs/docs/how-gatsby-works-with-github-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The easiest way to push a gatsby app to github pages is using a package called `

`yarn add --dev gh-pages`

## Github repository page
## GitHub repository page

Add a `deploy` script to `package.json`

Expand All @@ -28,7 +28,7 @@ We are using prefix paths because our website is inside a folder `http://usernam

When you run `yarn run deploy` all contents of `public` folder will be moved to your repositorys `gh-pages` branch.

## Github Organization or User page
## GitHub Organization or User page

First thing is to create a repository which should be named `username.github.io`.

Expand All @@ -43,4 +43,4 @@ In this case we dont need to specify `pathPrefix`, but our website needs to be p
}
```

After running `yarn run deplploy` you should see your website at `http://username.github.io`
After running `yarn run deploy` you should see your website at `http://username.github.io`
2 changes: 2 additions & 0 deletions docs/docs/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ root.
* [gatsby-plugin-copy](https://github.com/aquilio/gatsby-plugin-copy)
* [gatsby-plugin-elasticlunr-search](https://github.com/andrew-codes/gatsby-plugin-elasticlunr-search)
* [gatsby-plugin-google-fonts](https://github.com/didierfranc/gatsby-plugin-google-fonts)
* [gatsby-plugin-gosquared](https://github.com/jongold/gatsby-plugin-gosquared)
* [gatsby-plugin-hotjar](https://github.com/pavloko/gatsby-plugin-hotjar)
* [gatsby-plugin-i18n-readnext](https://github.com/angeloocana/gatsby-plugin-i18n-readnext)
* [gatsby-plugin-i18n-tags](https://github.com/angeloocana/gatsby-plugin-i18n-tags)
Expand All @@ -147,6 +148,7 @@ root.
* [gatsby-plugin-stripe-checkout](https://github.com/njosefbeck/gatsby-plugin-stripe-checkout)
* [gatsby-plugin-stripe-elements](https://github.com/njosefbeck/gatsby-plugin-stripe-elements)
* [gatsby-plugin-svgr](https://github.com/zabute/gatsby-plugin-svgr)
* [gatsby-plugin-typescript-css-modules](https://github.com/jcreamer898/gatsby-plugin-typescript-css-modules)
* [gatsby-plugin-yandex-metrika](https://github.com/viatsko/gatsby-plugin-yandex-metrika)
* [gatsby-remark-emoji](https://github.com/Rulikkk/gatsby-remark-emoji)
* [gatsby-remark-external-links](https://github.com/JLongley/gatsby-remark-external-links)
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/querying-with-graphql.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ look for \`template literal blocks\` with `allNode{}` in them.

* [GraphQL specification](https://facebook.github.io/graphql/October2016/)
* [Interfaces and Unions](https://medium.com/the-graphqlhub/graphql-tour-interfaces-and-unions-7dd5be35de0d)
* [Gatsby uses the Relay Compiler](https://facebook.github.io/relay/docs/en/relay-compiler.html)
* [Gatsby uses the Relay Compiler](https://facebook.github.io/relay/docs/en/compiler-architecture.html)
* ...

## TODO — create live GraphQL explorer for GatsbyJS.org
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/part-four/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ import kirkhamTheme from "typography-theme-kirkham";
const typography = new Typography(kirkhamTheme);
module.exports = typography;
export default typography;
```
`gatsby-config.js` (must be in the root of your project, not under src)
Expand Down
29 changes: 14 additions & 15 deletions docs/tutorial/part-one/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Sit down, buckle up, and let's get going!

## Check your development environment

Let's check first that you have everything setup to start creating with Gatsby.
Let's check first that you have everything set up to start creating with Gatsby.
You will need a recent version of [Node.js](https://nodejs.org) installed.

Node.js is a programming tool for running JavaScript on servers and in your
Expand All @@ -30,7 +30,7 @@ You should see something like:

![Check if node.js/npm is installed](check-versions.png)

Gatsby supports versions of Node back to v4 and NPM to v3.
Gatsby supports versions of Node back to v4 and npm to v3.

If you don't have Node.js installed, go to https://nodejs.org/ and install the
recommended version for your operating system.
Expand All @@ -56,7 +56,7 @@ gatsby new tutorial-part-one https://github.com/gatsbyjs/gatsby-starter-hello-wo
```

This command downloads the files for the starter and then installs the needed
NPM packages. It should take around 1.5-3 minutes to finish. It may look like
npm packages. It should take around 1.5-3 minutes to finish. It may look like
nothing is happening at first; be patient!

Now let's try running Gatsby!
Expand All @@ -81,18 +81,18 @@ Too cool 😎

Gatsby's development server is a "hot reloading" server, meaning any change you
make to your React.js page components (and later we'll learn, your data files)
will hot reload in the browser.
will be immediately visible and/or loaded in the browser.

This is huge because it makes development so much faster and fun.

Let's try it.

You'll need code editing software for the next part of this tutorial.
[VS Code](https://code.visualstudio.com/) is a nice one. With your code editor,
open a folder on your computer called "tutorial-part-one." This folder was
automatically created when you ran one of the terminal commands above.
open the folder on your computer called "tutorial-part-one," which was
automatically created when you ran the `gatsby new` terminal command above.

Now that you've opened the "tutorial-part-one" folder in your code editing
Once you've opened the "tutorial-part-one" folder in your code editing
software, it's time to edit your website. In the code editing software, you'll
need to find `src/pages/index.js`. Once you find that, try changing "Hello
world!" in the page component to "Hello Gatsby!". Once you save that change, the text in your browser
Expand Down Expand Up @@ -138,7 +138,7 @@ export default () =>
</div>
```

Now your screen should look something like this.
Now your screen should look something like this:

![Screen Shot 2017-06-03 at 11.57.10 AM](moving-along.png)

Expand Down Expand Up @@ -187,12 +187,11 @@ Make the second page component look something like:
import React from "react";
import Link from "gatsby-link";

export default () => (
<div>
export default () =>
return <div>
<p>Hello world from my second Gatsby page</p>
<Link to="/">back home</Link>
</div>
);
```

Save that and now you should be able to click back and forth between the two
Expand Down Expand Up @@ -276,7 +275,7 @@ export default Counter

So now we have everything we need to make a nice counter. Let's make it live.

First we'll setup the component state.
First we'll set up the component state.

```jsx{4-7,13}
import React from "react";
Expand Down Expand Up @@ -320,10 +319,10 @@ class Counter extends React.Component {
<div>
<h1>Counter</h1>
<p>current count: {this.state.count}</p>
<button onClick={() => this.setState({ count: this.state.count +
<button onClick={() => this.setState({ count: this.state.count +
1 })}>plus
</button>
<button onClick={() => this.setState({ count: this.state.count -
<button onClick={() => this.setState({ count: this.state.count -
1 })}>minus
</button>
</div>
Expand Down Expand Up @@ -366,7 +365,7 @@ Next, build your site by running the following command in the terminal at the ro
gatsby build
```

Building should take 15-30 seconds. At this point, it's useful to take a look at the files that the `gatsby build` command just prepared to deploy. Take a look at a list of the generated files typing in the following command into the root of your site, which will let you look at the `public` directory:
Building should take 15-30 seconds. At this point, it's useful to take a look at the files that the `gatsby build` command just prepared to deploy. Take a look at a list of the generated files by typing in the following terminal command into the root of your site, which will let you look at the `public` directory:

```bash
ls public
Expand Down
2 changes: 2 additions & 0 deletions examples/using-wordpress/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,5 @@ https://using-wordpress.gatsbyjs.org/

Example site that demonstrates how to build Gatsby sites that pull data from the
[WordPress CMS API](https://www.wordpress.com/).

IMPORTANT NOTE: This example site won't keep working if you switch the WordPress site to one of yours. It's meant as a learning resource. Try starting from scratch with a site created by `gatsby new` and start copying over parts from this site starting with `gatsby-config.js`.
2 changes: 1 addition & 1 deletion packages/gatsby-remark-katex/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

## Install

`npm install --save gatsby-transformer-remark atsby-remark-katex`
`npm install --save gatsby-transformer-remark gatsby-remark-katex`

## How to use

Expand Down

0 comments on commit 7127b7c

Please sign in to comment.