Format Markdown (#3058)

gatsbyjs · Nov 29, 2017 · 5c7d99d · 5c7d99d
1 parent 2caf191
commit 5c7d99d
Show file tree

Hide file tree

Showing 165 changed files with 6,094 additions and 3,541 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -12,13 +12,15 @@ If you want your issue to be resolved quickly, please include in your issue:
   changes you've made there.
 
 ## Contributing
+
 Gatsby uses a "monorepo" pattern to manage its many dependencies and relies on
 lerna and yarn to configure the repository for active development.
 
 You can install the latest version of Gatsby by following these steps:
 
 * Clone the repo, navigate to its directory.
-* ensure you have the latest version of yarn installed (>= 1.0.2) https://yarnpkg.com/en/docs/install
+* ensure you have the latest version of yarn installed (>= 1.0.2)
+  https://yarnpkg.com/en/docs/install
 * Install dependencies using `yarn run bootstrap` in the root of the repo.
 
 The usual contributing steps are:
@@ -28,14 +30,15 @@ The usual contributing steps are:
 * setup up repo and Install dependencies: `yarn run bootstrap`
 * Make sure tests are passing for you: `yarn test`
 * Create a topic branch: `git checkout -b topics/new-feature-name`
-* Run `npm run watch` from the root of the repo to first do an initial Babel build of all packages and then watch for
-  changes to packages' source code and compile these changes on-the-fly as you
-  work.
-* Install [gatsby-dev-cli](/packages/gatsby-dev-cli/) globally: `yarn global add gatsby-dev-cli`
+* Run `npm run watch` from the root of the repo to first do an initial Babel
+  build of all packages and then watch for changes to packages' source code and
+  compile these changes on-the-fly as you work.
+* Install [gatsby-dev-cli](/packages/gatsby-dev-cli/) globally: `yarn global add
+  gatsby-dev-cli`
 * For each of your Gatsby test sites, run the `gatsby-dev` command there to copy
   the built files from your cloned copy of Gatsby. It'll watch for your changes
-  to Gatsby packages and copy them into the site. For more detailed
-  instructions see the [gatsby-dev-cli README](/packages/gatsby-dev-cli/)
+  to Gatsby packages and copy them into the site. For more detailed instructions
+  see the [gatsby-dev-cli README](/packages/gatsby-dev-cli/)
 * Add tests and code for your changes.
 * Once you're done, make sure all tests still pass: `yarn test`
 * Commit and push to your fork.
@@ -45,25 +48,26 @@ The usual contributing steps are:
 
 ### Redux devtools
 
-Gatsby uses Redux for managing state during development and building. It's
-often helpful to see the flow of actions and builtup state for a site you're
-working on or if adding new functionality to core. We leverage
+Gatsby uses Redux for managing state during development and building. It's often
+helpful to see the flow of actions and builtup state for a site you're working
+on or if adding new functionality to core. We leverage
 https://github.com/zalmoxisus/remote-redux-devtools and
 https://github.com/zalmoxisus/remotedev-server to give you use the Redux
 devtools extension for debugging Gatsby.
 
 To use this, first install
 [redux-devtools-extension](https://github.com/zalmoxisus/redux-devtools-extension)
-in your browser. Then in your Gatsby repo, run `npm run remotedev`. Then in
-your site directory run `REDUX_DEVTOOLS=true gatsby develop`. Depending on
-your operating system and shell, you may need to modify how you set the
+in your browser. Then in your Gatsby repo, run `npm run remotedev`. Then in your
+site directory run `REDUX_DEVTOOLS=true gatsby develop`. Depending on your
+operating system and shell, you may need to modify how you set the
 `REDUX_DEVTOOLS` environment variable.
 
-At this point, your site will be sending Redux actions and state to the remote server.
-
-To connect to this, you need to setup the devtools extension to talk to the remote
+At this point, your site will be sending Redux actions and state to the remote
 server.
 
+To connect to this, you need to setup the devtools extension to talk to the
+remote server.
+
 First open the remote devtools.
 
 ![how to open the redux remote devtools extension](./images/open-remote-dev-tools.png)
@@ -72,16 +76,16 @@ Then click settings along the bottom menu and set the host and port.
 
 ![how to set the host/port for the remote devtools extension to connect to Gatsby](./images/remote-dev-settings.png)
 
-After this, the devtools extension *should* connect to the remote server and you'll
-see actions start showing up.
+After this, the devtools extension _should_ connect to the remote server and
+you'll see actions start showing up.
 
 ![gatsby redux remote devtools](./images/running-redux-devtools.png)
 
 **Warning!! Lots of buginess**. While having this available is extremely
 helpful, this setup is very buggy and fragile. There is a memory leak in the
 extension that's triggered it seems every time you restart the Gatsby
-development server. Also the extension often, for no apparent reason, just
-won't show any actions from the remote server. It'll also often freeze up. The
-best solution seems to just be turning everything off and on again.  Fixing up
-these tools would be very helpful for us and many others using these tools if
-someone wants to take this on!
+development server. Also the extension often, for no apparent reason, just won't
+show any actions from the remote server. It'll also often freeze up. The best
+solution seems to just be turning everything off and on again. Fixing up these
+tools would be very helpful for us and many others using these tools if someone
+wants to take this on!
diff --git a/README.md b/README.md
@@ -14,7 +14,9 @@
 ## Showcase
 
 Websites built with Gatsby:
-* [React](https://reactjs.org/) ([source](https://github.com/reactjs/reactjs.org))
+
+* [React](https://reactjs.org/)
+  ([source](https://github.com/reactjs/reactjs.org))
 * [Sourcegraph](https://about.sourcegraph.com)
 * [Simply](https://simply.co.za)
 * [The freeCodeCamp Guide](https://guide.freecodecamp.org)
@@ -23,43 +25,65 @@ Websites built with Gatsby:
 * [Segment's Blog](https://segment.com/blog/)
 * [Fabric](https://meetfabric.com/)
 * [Formidable](https://formidable.com/)
-* [openFDA](https://open.fda.gov/) ([source](https://github.com/FDA/open.fda.gov))
-* [ReasonML Docs](https://reasonml.github.io/) ([source](https://github.com/reasonml/reasonml.github.io))
-* [Bricolage.io](https://www.bricolage.io/) ([source](https://github.com/KyleAMathews/blog))
-* [Jamie Henson's Blog](http://jamiehenson.com/) ([source](https://github.com/jamiehenson/jh47-gatsby))
+* [openFDA](https://open.fda.gov/)
+  ([source](https://github.com/FDA/open.fda.gov))
+* [ReasonML Docs](https://reasonml.github.io/)
+  ([source](https://github.com/reasonml/reasonml.github.io))
+* [Bricolage.io](https://www.bricolage.io/)
+  ([source](https://github.com/KyleAMathews/blog))
+* [Jamie Henson's Blog](http://jamiehenson.com/)
+  ([source](https://github.com/jamiehenson/jh47-gatsby))
 * [Sean Coker's Blog](https://sean.is/)
-* [Dustin Schau's Blog](https://dustinschau.com/blog/) ([source](https://github.com/dschau/blog))
+* [Dustin Schau's Blog](https://dustinschau.com/blog/)
+  ([source](https://github.com/dschau/blog))
 * [The Chiedo Companies Website](https://www.chiedo.com)
-* [Damir.io](http://damir.io/) ([source](https://github.com/dvzrd/gatsby-sfiction))
+* [Damir.io](http://damir.io/)
+  ([source](https://github.com/dvzrd/gatsby-sfiction))
 * [Ruben's Blog](https://vagr9k.me/) ([source](https://github.com/Vagr9K/Blog))
-* [Kostas Bariotis' Blog](https://kostasbariotis.com/) ([source](https://github.com/kbariotis/kostasbariotis.com))
+* [Kostas Bariotis' Blog](https://kostasbariotis.com/)
+  ([source](https://github.com/kbariotis/kostasbariotis.com))
 * [Thao Am Private Enterprise](http://thaoam.com/)
 * [Bakadono](http://bakadono.com/)
 * [Travellers.cafe](https://travellers.cafe/)
-* [Oliver Benns' Portfolio](https://oliverbenns.com) ([source](https://github.com/oliverbenns/oliverbenns.com))
-* [angeloocana.com](https://angeloocana.com) ([source](https://github.com/angeloocana/angeloocana))
+* [Oliver Benns' Portfolio](https://oliverbenns.com)
+  ([source](https://github.com/oliverbenns/oliverbenns.com))
+* [angeloocana.com](https://angeloocana.com)
+  ([source](https://github.com/angeloocana/angeloocana))
 * [knpw.rs](https://knpw.rs) ([source](https://github.com/knpwrs/knpw.rs))
-* [Overlap.show](https://overlap.show) ([source](https://github.com/pouretrebelle/overlap.show))
+* [Overlap.show](https://overlap.show)
+  ([source](https://github.com/pouretrebelle/overlap.show))
 * [smartive Company Website](https://smartive.ch)
 * [Haboba Find Jobs at Phu Quoc Island](http://haboba.com)
-* [Charlie Harrington's Blog](https://charlieharrington.com) ([source](https://github.com/whatrocks/blog))
-* [Song Wang’s website](https://songwang.io/) ([source](https://github.com/wangsongiam/songwang.io))
-* [Digital Psychology](http://digitalpsychology.io) ([source](https://github.com/danistefanovic/digitalpsychology.io))
-* [Magicly's blog](https://magicly.me/) ([source](https://github.com/magicly/gatsby-blog))
-* [Dalbinaco's website](http://dalbinaco.com/) ([source](https://github.com/dalbinaco/dalbinaco.github.io))
+* [Charlie Harrington's Blog](https://charlieharrington.com)
+  ([source](https://github.com/whatrocks/blog))
+* [Song Wang’s website](https://songwang.io/)
+  ([source](https://github.com/wangsongiam/songwang.io))
+* [Digital Psychology](http://digitalpsychology.io)
+  ([source](https://github.com/danistefanovic/digitalpsychology.io))
+* [Magicly's blog](https://magicly.me/)
+  ([source](https://github.com/magicly/gatsby-blog))
+* [Dalbinaco's website](http://dalbinaco.com/)
+  ([source](https://github.com/dalbinaco/dalbinaco.github.io))
 * [Phu Quoc Works](http://phuquocworks.net)
-* [Kabir Goel's website](https://kbrgl.github.io) ([source](https://github.com/kbrgl/kbrgl.github.io))
-* [Gabriel Adorf's Portfolio](https://gabrieladorf.com/) ([source](https://github.com/gabdorf/gabriel-adorf-portfolio))
-* [CSS Grid Playground by MozillaDev](https://mozilladevelopers.github.io/playground/) ([source](https://github.com/MozillaDevelopers/playground))
-* [David James' Portfolio](http://dfjames.com) ([source](https://github.com/daviddeejjames/dfjames-gatsby))
-* [Tic Tac Toe AI](https://tic-tac-toe-ai.surge.sh) ([source](https://github.com/angeloocana/tic-tac-toe-ai))
-* [Etcetera Design](https://etcetera.design) ([source](https://github.com/etceteradesign/website))
+* [Kabir Goel's website](https://kbrgl.github.io)
+  ([source](https://github.com/kbrgl/kbrgl.github.io))
+* [Gabriel Adorf's Portfolio](https://gabrieladorf.com/)
+  ([source](https://github.com/gabdorf/gabriel-adorf-portfolio))
+* [CSS Grid Playground by MozillaDev](https://mozilladevelopers.github.io/playground/)
+  ([source](https://github.com/MozillaDevelopers/playground))
+* [David James' Portfolio](http://dfjames.com)
+  ([source](https://github.com/daviddeejjames/dfjames-gatsby))
+* [Tic Tac Toe AI](https://tic-tac-toe-ai.surge.sh)
+  ([source](https://github.com/angeloocana/tic-tac-toe-ai))
+* [Etcetera Design](https://etcetera.design)
+  ([source](https://github.com/etceteradesign/website))
 * [Azer Koçulu](http://azer.bike)
 * [Random Screencast](https://randomscreencast.com)
 * [Phu Quoc Tea & Coffee Store](http://trasuaphuquoc.com)
 * [Steven Natera's blog](https://www.stevennatera.com)
 * [LekoArts - Graphic Designer](https://www.lekoarts.de)
-* [Georgi Yanev](https://blog.georgi-yanev.com) ([source](https://github.com/jumpalottahigh/blog.georgi-yanev.com))
+* [Georgi Yanev](https://blog.georgi-yanev.com)
+  ([source](https://github.com/jumpalottahigh/blog.georgi-yanev.com))
 * [OnCallogy.com](https://www.oncallogy.com)
 * [doopoll's marketing site](https://doopoll.co)
 * [Design Systems Weekly](https://designsystems.email/)
@@ -70,15 +94,22 @@ Websites built with Gatsby:
 * [JavaScript Stuff](https://www.javascriptstuff.com)
 * [GRANDstack - GraphQL, React, Apollo, Neo4j Database](http://grandstack.io/)
 * [GraphCMS's website](https://graphcms.com)
-* [Mannequin.io](https://mannequin.io) ([source](https://github.com/LastCallMedia/Mannequin/tree/master/site))
+* [Mannequin.io](https://mannequin.io)
+  ([source](https://github.com/LastCallMedia/Mannequin/tree/master/site))
 * [Calpa's Blog](https://calpa.me) [(source)](https://github.com/calpa/blog)
-* [API Platform](https://api-platform.com) ([source](https://github.com/api-platform/website))
-* [Bottender Docs](https://bottender.js.org/) ([source](https://github.com/bottenderjs/bottenderjs.github.io))
-* [How to GraphQL](https://www.howtographql.com/) ([source](https://github.com/howtographql/howtographql))
-* [greglobinski.com](https://greglobinski.com) ([source](https://github.com/greglobinski/greglobinski-com))
+* [API Platform](https://api-platform.com)
+  ([source](https://github.com/api-platform/website))
+* [Bottender Docs](https://bottender.js.org/)
+  ([source](https://github.com/bottenderjs/bottenderjs.github.io))
+* [How to GraphQL](https://www.howtographql.com/)
+  ([source](https://github.com/howtographql/howtographql))
+* [greglobinski.com](https://greglobinski.com)
+  ([source](https://github.com/greglobinski/greglobinski-com))
 * [Vibert Thio's Portfolio](https://vibertthio.com/portfolio/)([source](https://github.com/vibertthio/portfolio))
-* [hunterchang.com](https://hunterchang.com) ([source](https://github.com/ChangoMan/hc-gatsby))
-* [YouFoundRon.com](https://youfoundron.com) ([source](https://github.com/rongierlach/yfr-dot-com))
+* [hunterchang.com](https://hunterchang.com)
+  ([source](https://github.com/ChangoMan/hc-gatsby))
+* [YouFoundRon.com](https://youfoundron.com)
+  ([source](https://github.com/rongierlach/yfr-dot-com))
 
 ## Docs
 
@@ -90,15 +121,19 @@ Websites built with Gatsby:
 
 ## Packages
 
-This repository is a monorepo managed using [Lerna](https://github.com/lerna/lerna). This means that we publish [many packages](/packages) to NPM from the same codebase.
+This repository is a monorepo managed using
+[Lerna](https://github.com/lerna/lerna). This means that we publish
+[many packages](/packages) to NPM from the same codebase.
 
 ## Thanks
 
-Thanks to our many contributors and sponsors as well as the companies sponsoring our testing and hosting infrastructure, Travis CI, Appveyor, and Netlify.
+Thanks to our many contributors and sponsors as well as the companies sponsoring
+our testing and hosting infrastructure, Travis CI, Appveyor, and Netlify.
 
 ## Backers
 
-Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/gatsby#backer)]
+Support us with a monthly donation and help us continue our activities.
+[[Become a backer](https://opencollective.com/gatsby#backer)]
 
 <a href="https://opencollective.com/gatsby/backer/0/website" target="_blank"><img src="https://opencollective.com/gatsby/backer/0/avatar.svg"></a>
 <a href="https://opencollective.com/gatsby/backer/1/website" target="_blank"><img src="https://opencollective.com/gatsby/backer/1/avatar.svg"></a>
@@ -131,10 +166,10 @@ Support us with a monthly donation and help us continue our activities. [[Become
 <a href="https://opencollective.com/gatsby/backer/28/website" target="_blank"><img src="https://opencollective.com/gatsby/backer/28/avatar.svg"></a>
 <a href="https://opencollective.com/gatsby/backer/29/website" target="_blank"><img src="https://opencollective.com/gatsby/backer/29/avatar.svg"></a>
 
-
 ## Sponsors
 
-Become a sponsor and get your logo on our README on GitHub with a link to your site. [[Become a sponsor](https://opencollective.com/gatsby#sponsor)]
+Become a sponsor and get your logo on our README on GitHub with a link to your
+site. [[Become a sponsor](https://opencollective.com/gatsby#sponsor)]
 
 <a href="https://opencollective.com/gatsby/sponsor/0/website" target="_blank"><img src="https://opencollective.com/gatsby/sponsor/0/avatar.svg"></a>
 <a href="https://opencollective.com/gatsby/sponsor/1/website" target="_blank"><img src="https://opencollective.com/gatsby/sponsor/1/avatar.svg"></a>

diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,7 @@
 # Read docs at https://www.gatsbyjs.org/docs
 
-We intend the docs to be read on gatsbyjs.org — you can read them here of course :-) just be warned that links won't often work and other things will be missing or less than optimal.
+We intend the docs to be read on gatsbyjs.org — you can read them here of course
+:-) just be warned that links won't often work and other things will be missing
+or less than optimal.
 
 Go forth and build cool stuff.