Skip to content

Commit 5c7d99d

Browse files
authored
Format Markdown (#3058)
1 parent 2caf191 commit 5c7d99d

File tree

165 files changed

+6094
-3541
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

165 files changed

+6094
-3541
lines changed

CHANGELOG.md

Lines changed: 322 additions & 233 deletions
Large diffs are not rendered by default.

CONTRIBUTING.md

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,15 @@ If you want your issue to be resolved quickly, please include in your issue:
1212
changes you've made there.
1313

1414
## Contributing
15+
1516
Gatsby uses a "monorepo" pattern to manage its many dependencies and relies on
1617
lerna and yarn to configure the repository for active development.
1718

1819
You can install the latest version of Gatsby by following these steps:
1920

2021
* Clone the repo, navigate to its directory.
21-
* ensure you have the latest version of yarn installed (>= 1.0.2) https://yarnpkg.com/en/docs/install
22+
* ensure you have the latest version of yarn installed (>= 1.0.2)
23+
https://yarnpkg.com/en/docs/install
2224
* Install dependencies using `yarn run bootstrap` in the root of the repo.
2325

2426
The usual contributing steps are:
@@ -28,14 +30,15 @@ The usual contributing steps are:
2830
* setup up repo and Install dependencies: `yarn run bootstrap`
2931
* Make sure tests are passing for you: `yarn test`
3032
* Create a topic branch: `git checkout -b topics/new-feature-name`
31-
* Run `npm run watch` from the root of the repo to first do an initial Babel build of all packages and then watch for
32-
changes to packages' source code and compile these changes on-the-fly as you
33-
work.
34-
* Install [gatsby-dev-cli](/packages/gatsby-dev-cli/) globally: `yarn global add gatsby-dev-cli`
33+
* Run `npm run watch` from the root of the repo to first do an initial Babel
34+
build of all packages and then watch for changes to packages' source code and
35+
compile these changes on-the-fly as you work.
36+
* Install [gatsby-dev-cli](/packages/gatsby-dev-cli/) globally: `yarn global add
37+
gatsby-dev-cli`
3538
* For each of your Gatsby test sites, run the `gatsby-dev` command there to copy
3639
the built files from your cloned copy of Gatsby. It'll watch for your changes
37-
to Gatsby packages and copy them into the site. For more detailed
38-
instructions see the [gatsby-dev-cli README](/packages/gatsby-dev-cli/)
40+
to Gatsby packages and copy them into the site. For more detailed instructions
41+
see the [gatsby-dev-cli README](/packages/gatsby-dev-cli/)
3942
* Add tests and code for your changes.
4043
* Once you're done, make sure all tests still pass: `yarn test`
4144
* Commit and push to your fork.
@@ -45,25 +48,26 @@ The usual contributing steps are:
4548

4649
### Redux devtools
4750

48-
Gatsby uses Redux for managing state during development and building. It's
49-
often helpful to see the flow of actions and builtup state for a site you're
50-
working on or if adding new functionality to core. We leverage
51+
Gatsby uses Redux for managing state during development and building. It's often
52+
helpful to see the flow of actions and builtup state for a site you're working
53+
on or if adding new functionality to core. We leverage
5154
https://github.com/zalmoxisus/remote-redux-devtools and
5255
https://github.com/zalmoxisus/remotedev-server to give you use the Redux
5356
devtools extension for debugging Gatsby.
5457

5558
To use this, first install
5659
[redux-devtools-extension](https://github.com/zalmoxisus/redux-devtools-extension)
57-
in your browser. Then in your Gatsby repo, run `npm run remotedev`. Then in
58-
your site directory run `REDUX_DEVTOOLS=true gatsby develop`. Depending on
59-
your operating system and shell, you may need to modify how you set the
60+
in your browser. Then in your Gatsby repo, run `npm run remotedev`. Then in your
61+
site directory run `REDUX_DEVTOOLS=true gatsby develop`. Depending on your
62+
operating system and shell, you may need to modify how you set the
6063
`REDUX_DEVTOOLS` environment variable.
6164

62-
At this point, your site will be sending Redux actions and state to the remote server.
63-
64-
To connect to this, you need to setup the devtools extension to talk to the remote
65+
At this point, your site will be sending Redux actions and state to the remote
6566
server.
6667

68+
To connect to this, you need to setup the devtools extension to talk to the
69+
remote server.
70+
6771
First open the remote devtools.
6872

6973
![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.
7276

7377
![how to set the host/port for the remote devtools extension to connect to Gatsby](./images/remote-dev-settings.png)
7478

75-
After this, the devtools extension *should* connect to the remote server and you'll
76-
see actions start showing up.
79+
After this, the devtools extension _should_ connect to the remote server and
80+
you'll see actions start showing up.
7781

7882
![gatsby redux remote devtools](./images/running-redux-devtools.png)
7983

8084
**Warning!! Lots of buginess**. While having this available is extremely
8185
helpful, this setup is very buggy and fragile. There is a memory leak in the
8286
extension that's triggered it seems every time you restart the Gatsby
83-
development server. Also the extension often, for no apparent reason, just
84-
won't show any actions from the remote server. It'll also often freeze up. The
85-
best solution seems to just be turning everything off and on again. Fixing up
86-
these tools would be very helpful for us and many others using these tools if
87-
someone wants to take this on!
87+
development server. Also the extension often, for no apparent reason, just won't
88+
show any actions from the remote server. It'll also often freeze up. The best
89+
solution seems to just be turning everything off and on again. Fixing up these
90+
tools would be very helpful for us and many others using these tools if someone
91+
wants to take this on!

README.md

Lines changed: 70 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@
1414
## Showcase
1515

1616
Websites built with Gatsby:
17-
* [React](https://reactjs.org/) ([source](https://github.com/reactjs/reactjs.org))
17+
18+
* [React](https://reactjs.org/)
19+
([source](https://github.com/reactjs/reactjs.org))
1820
* [Sourcegraph](https://about.sourcegraph.com)
1921
* [Simply](https://simply.co.za)
2022
* [The freeCodeCamp Guide](https://guide.freecodecamp.org)
@@ -23,43 +25,65 @@ Websites built with Gatsby:
2325
* [Segment's Blog](https://segment.com/blog/)
2426
* [Fabric](https://meetfabric.com/)
2527
* [Formidable](https://formidable.com/)
26-
* [openFDA](https://open.fda.gov/) ([source](https://github.com/FDA/open.fda.gov))
27-
* [ReasonML Docs](https://reasonml.github.io/) ([source](https://github.com/reasonml/reasonml.github.io))
28-
* [Bricolage.io](https://www.bricolage.io/) ([source](https://github.com/KyleAMathews/blog))
29-
* [Jamie Henson's Blog](http://jamiehenson.com/) ([source](https://github.com/jamiehenson/jh47-gatsby))
28+
* [openFDA](https://open.fda.gov/)
29+
([source](https://github.com/FDA/open.fda.gov))
30+
* [ReasonML Docs](https://reasonml.github.io/)
31+
([source](https://github.com/reasonml/reasonml.github.io))
32+
* [Bricolage.io](https://www.bricolage.io/)
33+
([source](https://github.com/KyleAMathews/blog))
34+
* [Jamie Henson's Blog](http://jamiehenson.com/)
35+
([source](https://github.com/jamiehenson/jh47-gatsby))
3036
* [Sean Coker's Blog](https://sean.is/)
31-
* [Dustin Schau's Blog](https://dustinschau.com/blog/) ([source](https://github.com/dschau/blog))
37+
* [Dustin Schau's Blog](https://dustinschau.com/blog/)
38+
([source](https://github.com/dschau/blog))
3239
* [The Chiedo Companies Website](https://www.chiedo.com)
33-
* [Damir.io](http://damir.io/) ([source](https://github.com/dvzrd/gatsby-sfiction))
40+
* [Damir.io](http://damir.io/)
41+
([source](https://github.com/dvzrd/gatsby-sfiction))
3442
* [Ruben's Blog](https://vagr9k.me/) ([source](https://github.com/Vagr9K/Blog))
35-
* [Kostas Bariotis' Blog](https://kostasbariotis.com/) ([source](https://github.com/kbariotis/kostasbariotis.com))
43+
* [Kostas Bariotis' Blog](https://kostasbariotis.com/)
44+
([source](https://github.com/kbariotis/kostasbariotis.com))
3645
* [Thao Am Private Enterprise](http://thaoam.com/)
3746
* [Bakadono](http://bakadono.com/)
3847
* [Travellers.cafe](https://travellers.cafe/)
39-
* [Oliver Benns' Portfolio](https://oliverbenns.com) ([source](https://github.com/oliverbenns/oliverbenns.com))
40-
* [angeloocana.com](https://angeloocana.com) ([source](https://github.com/angeloocana/angeloocana))
48+
* [Oliver Benns' Portfolio](https://oliverbenns.com)
49+
([source](https://github.com/oliverbenns/oliverbenns.com))
50+
* [angeloocana.com](https://angeloocana.com)
51+
([source](https://github.com/angeloocana/angeloocana))
4152
* [knpw.rs](https://knpw.rs) ([source](https://github.com/knpwrs/knpw.rs))
42-
* [Overlap.show](https://overlap.show) ([source](https://github.com/pouretrebelle/overlap.show))
53+
* [Overlap.show](https://overlap.show)
54+
([source](https://github.com/pouretrebelle/overlap.show))
4355
* [smartive Company Website](https://smartive.ch)
4456
* [Haboba Find Jobs at Phu Quoc Island](http://haboba.com)
45-
* [Charlie Harrington's Blog](https://charlieharrington.com) ([source](https://github.com/whatrocks/blog))
46-
* [Song Wang’s website](https://songwang.io/) ([source](https://github.com/wangsongiam/songwang.io))
47-
* [Digital Psychology](http://digitalpsychology.io) ([source](https://github.com/danistefanovic/digitalpsychology.io))
48-
* [Magicly's blog](https://magicly.me/) ([source](https://github.com/magicly/gatsby-blog))
49-
* [Dalbinaco's website](http://dalbinaco.com/) ([source](https://github.com/dalbinaco/dalbinaco.github.io))
57+
* [Charlie Harrington's Blog](https://charlieharrington.com)
58+
([source](https://github.com/whatrocks/blog))
59+
* [Song Wang’s website](https://songwang.io/)
60+
([source](https://github.com/wangsongiam/songwang.io))
61+
* [Digital Psychology](http://digitalpsychology.io)
62+
([source](https://github.com/danistefanovic/digitalpsychology.io))
63+
* [Magicly's blog](https://magicly.me/)
64+
([source](https://github.com/magicly/gatsby-blog))
65+
* [Dalbinaco's website](http://dalbinaco.com/)
66+
([source](https://github.com/dalbinaco/dalbinaco.github.io))
5067
* [Phu Quoc Works](http://phuquocworks.net)
51-
* [Kabir Goel's website](https://kbrgl.github.io) ([source](https://github.com/kbrgl/kbrgl.github.io))
52-
* [Gabriel Adorf's Portfolio](https://gabrieladorf.com/) ([source](https://github.com/gabdorf/gabriel-adorf-portfolio))
53-
* [CSS Grid Playground by MozillaDev](https://mozilladevelopers.github.io/playground/) ([source](https://github.com/MozillaDevelopers/playground))
54-
* [David James' Portfolio](http://dfjames.com) ([source](https://github.com/daviddeejjames/dfjames-gatsby))
55-
* [Tic Tac Toe AI](https://tic-tac-toe-ai.surge.sh) ([source](https://github.com/angeloocana/tic-tac-toe-ai))
56-
* [Etcetera Design](https://etcetera.design) ([source](https://github.com/etceteradesign/website))
68+
* [Kabir Goel's website](https://kbrgl.github.io)
69+
([source](https://github.com/kbrgl/kbrgl.github.io))
70+
* [Gabriel Adorf's Portfolio](https://gabrieladorf.com/)
71+
([source](https://github.com/gabdorf/gabriel-adorf-portfolio))
72+
* [CSS Grid Playground by MozillaDev](https://mozilladevelopers.github.io/playground/)
73+
([source](https://github.com/MozillaDevelopers/playground))
74+
* [David James' Portfolio](http://dfjames.com)
75+
([source](https://github.com/daviddeejjames/dfjames-gatsby))
76+
* [Tic Tac Toe AI](https://tic-tac-toe-ai.surge.sh)
77+
([source](https://github.com/angeloocana/tic-tac-toe-ai))
78+
* [Etcetera Design](https://etcetera.design)
79+
([source](https://github.com/etceteradesign/website))
5780
* [Azer Koçulu](http://azer.bike)
5881
* [Random Screencast](https://randomscreencast.com)
5982
* [Phu Quoc Tea & Coffee Store](http://trasuaphuquoc.com)
6083
* [Steven Natera's blog](https://www.stevennatera.com)
6184
* [LekoArts - Graphic Designer](https://www.lekoarts.de)
62-
* [Georgi Yanev](https://blog.georgi-yanev.com) ([source](https://github.com/jumpalottahigh/blog.georgi-yanev.com))
85+
* [Georgi Yanev](https://blog.georgi-yanev.com)
86+
([source](https://github.com/jumpalottahigh/blog.georgi-yanev.com))
6387
* [OnCallogy.com](https://www.oncallogy.com)
6488
* [doopoll's marketing site](https://doopoll.co)
6589
* [Design Systems Weekly](https://designsystems.email/)
@@ -70,15 +94,22 @@ Websites built with Gatsby:
7094
* [JavaScript Stuff](https://www.javascriptstuff.com)
7195
* [GRANDstack - GraphQL, React, Apollo, Neo4j Database](http://grandstack.io/)
7296
* [GraphCMS's website](https://graphcms.com)
73-
* [Mannequin.io](https://mannequin.io) ([source](https://github.com/LastCallMedia/Mannequin/tree/master/site))
97+
* [Mannequin.io](https://mannequin.io)
98+
([source](https://github.com/LastCallMedia/Mannequin/tree/master/site))
7499
* [Calpa's Blog](https://calpa.me) [(source)](https://github.com/calpa/blog)
75-
* [API Platform](https://api-platform.com) ([source](https://github.com/api-platform/website))
76-
* [Bottender Docs](https://bottender.js.org/) ([source](https://github.com/bottenderjs/bottenderjs.github.io))
77-
* [How to GraphQL](https://www.howtographql.com/) ([source](https://github.com/howtographql/howtographql))
78-
* [greglobinski.com](https://greglobinski.com) ([source](https://github.com/greglobinski/greglobinski-com))
100+
* [API Platform](https://api-platform.com)
101+
([source](https://github.com/api-platform/website))
102+
* [Bottender Docs](https://bottender.js.org/)
103+
([source](https://github.com/bottenderjs/bottenderjs.github.io))
104+
* [How to GraphQL](https://www.howtographql.com/)
105+
([source](https://github.com/howtographql/howtographql))
106+
* [greglobinski.com](https://greglobinski.com)
107+
([source](https://github.com/greglobinski/greglobinski-com))
79108
* [Vibert Thio's Portfolio](https://vibertthio.com/portfolio/)([source](https://github.com/vibertthio/portfolio))
80-
* [hunterchang.com](https://hunterchang.com) ([source](https://github.com/ChangoMan/hc-gatsby))
81-
* [YouFoundRon.com](https://youfoundron.com) ([source](https://github.com/rongierlach/yfr-dot-com))
109+
* [hunterchang.com](https://hunterchang.com)
110+
([source](https://github.com/ChangoMan/hc-gatsby))
111+
* [YouFoundRon.com](https://youfoundron.com)
112+
([source](https://github.com/rongierlach/yfr-dot-com))
82113

83114
## Docs
84115

@@ -90,15 +121,19 @@ Websites built with Gatsby:
90121

91122
## Packages
92123

93-
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.
124+
This repository is a monorepo managed using
125+
[Lerna](https://github.com/lerna/lerna). This means that we publish
126+
[many packages](/packages) to NPM from the same codebase.
94127

95128
## Thanks
96129

97-
Thanks to our many contributors and sponsors as well as the companies sponsoring our testing and hosting infrastructure, Travis CI, Appveyor, and Netlify.
130+
Thanks to our many contributors and sponsors as well as the companies sponsoring
131+
our testing and hosting infrastructure, Travis CI, Appveyor, and Netlify.
98132

99133
## Backers
100134

101-
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/gatsby#backer)]
135+
Support us with a monthly donation and help us continue our activities.
136+
[[Become a backer](https://opencollective.com/gatsby#backer)]
102137

103138
<a href="https://opencollective.com/gatsby/backer/0/website" target="_blank"><img src="https://opencollective.com/gatsby/backer/0/avatar.svg"></a>
104139
<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
131166
<a href="https://opencollective.com/gatsby/backer/28/website" target="_blank"><img src="https://opencollective.com/gatsby/backer/28/avatar.svg"></a>
132167
<a href="https://opencollective.com/gatsby/backer/29/website" target="_blank"><img src="https://opencollective.com/gatsby/backer/29/avatar.svg"></a>
133168

134-
135169
## Sponsors
136170

137-
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)]
171+
Become a sponsor and get your logo on our README on GitHub with a link to your
172+
site. [[Become a sponsor](https://opencollective.com/gatsby#sponsor)]
138173

139174
<a href="https://opencollective.com/gatsby/sponsor/0/website" target="_blank"><img src="https://opencollective.com/gatsby/sponsor/0/avatar.svg"></a>
140175
<a href="https://opencollective.com/gatsby/sponsor/1/website" target="_blank"><img src="https://opencollective.com/gatsby/sponsor/1/avatar.svg"></a>

docs/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Read docs at https://www.gatsbyjs.org/docs
22

3-
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.
3+
We intend the docs to be read on gatsbyjs.org — you can read them here of course
4+
:-) just be warned that links won't often work and other things will be missing
5+
or less than optimal.
46

57
Go forth and build cool stuff.

0 commit comments

Comments
 (0)