Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #4503 #4698

Merged
merged 5 commits into from
Mar 26, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ Next, we analyzed over 10 admirable and/or popular plugin libraries to draw from
* [Apple App store](https://www.apple.com/ios/app-store/)
* [Google Play store](https://play.google.com/store/apps/top)


### The goods 👍

We liked when these libraries let users:
Expand All @@ -55,14 +54,13 @@ We liked when these libraries let users:

### The bads 👎

We *didn't* like these things in some of the above libraries:
We _didn't_ like these things in some of the above libraries:

* poor contrast and poor information heirarchy
* limited filters
* too many filters
* low information density


## Prototypes and their evolutions

Here’s a sampling of screenshots that many community members contributed to and gave feedback about. It’s rewarding to see how much the design has progressed (and will keep progressing).
Expand All @@ -74,17 +72,16 @@ Here’s a sampling of screenshots that many community members contributed to an

## Next steps for the plugin library

The plugin ecosystem is a huge part of what makes Gatsby awesome because plugins and packages make Gatsby extensible. There's a virtuous cycle where people find plugins, use them, contribute to them, and create new ones. We hope to accelerate this cycle, so the Gatsby ecosystem can develop faster and more people can build awesome sites!
The plugin ecosystem is a huge part of what makes Gatsby awesome because plugins and packages make Gatsby extensible. There's a virtuous cycle where people find plugins, use them, contribute to them, and create new ones. We hope to accelerate this cycle, so the Gatsby ecosystem can develop faster and more people can build awesome sites!

Here are some ways you can help make the Gatsby plugin ecoystem great:

* Share feedback on the plugin library on [Github Issue #4394](https://github.com/gatsbyjs/gatsby/issues/4394).
* If you created a plugin and it's not showing up in the library, double check that the package has "gatsby-plugin" in its keywords.
* Create plugins (or publish ones you've already built)! If you're interested, the [Plugin Authoring](/docs/plugin-authoring/) page can help.
* [Contact me](https://twitter.com/shannonb_ux/status/938551014956732418) here if you have feedback that differs from or provides deeper insight into one of the pain points this article mentions.
* [Contact me](https://twitter.com/shannonb_ux/status/938551014956732418) here if you have feedback that differs from or provides deeper insight into one of the pain points this article mentions.
* Follow us on [Twitter](https://twitter.com/gatsbyjs).


## Sneak peak into the next UX project

Our next UX project is designing and building a [Gatsby site showcase](https://github.com/gatsbyjs/gatsby/issues/4394). Please contribute to and subscribe to the issue to help out!
Expand Down
109 changes: 53 additions & 56 deletions docs/docs/gatsby-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ _Note: There are many sample configs which may be helpful to reference in the di

Options available to set within `gatsby-config.js` include:

1. siteMetadata (object)
2. plugins (array)
3. pathPrefix (string)
4. polyfill (boolean)
5. mapping (object)
6. proxy (object)
1. siteMetadata (object)
2. plugins (array)
3. pathPrefix (string)
4. polyfill (boolean)
5. mapping (object)
6. proxy (object)

## siteMetadata

Expand Down Expand Up @@ -142,47 +142,44 @@ query BlogPost($slug: String!) {
Mapping can also be used to map an array of ids to any other collection of data. For example, if you have two JSON files
`experience.json` and `tech.json` as follows:

```javascript
```json
// experience.json
[
{
"id": "companyA",
"company": "Company A",
"position": "Unicorn Developer",
"from": "Dec 2016",
"to": "Present",
"items": [
{
"label": "Responsibility",
"description": "Being an unicorn"
},
{
"label": "Hands on",
"tech": [
"REACT",
"NODE"
]
}
]
},
{
"id": "companyA",
"company": "Company A",
"position": "Unicorn Developer",
"from": "Dec 2016",
"to": "Present",
"items": [
{
"label": "Responsibility",
"description": "Being an unicorn"
},
{
"label": "Hands on",
"tech": ["REACT", "NODE"]
}
]
}
]
```

```javascript
```json
// tech.json
[
{
"id": "REACT",
"icon": "facebook",
"color": "teal",
"label": "React"
},
{
"id": "NODE",
"icon": "server",
"color": "green",
"label": "NodeJS"
}
{
"id": "REACT",
"icon": "facebook",
"color": "teal",
"label": "React"
},
{
"id": "NODE",
"icon": "server",
"color": "green",
"label": "NodeJS"
}
]
```

Expand All @@ -202,24 +199,24 @@ You can query the `tech` object via the referred ids in `experience`:
```graphql
query CV {
experience: allExperienceJson {
edges {
node {
company
position
from
to
items {
label
description
link
tech {
label
color
icon
}
}
edges {
node {
company
position
from
to
items {
label
description
link
tech {
label
color
icon
}
}
}
}
}
}
```
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/gatsby-starters.md
Original file line number Diff line number Diff line change
Expand Up @@ -299,15 +299,15 @@ Community:
[(demo)](https://gatsby-starter-personal-blog.greglobinski.com/)

Features:

* Ready to use, but easily customizable a fully equipped theme starter
* Easy editable content in Markdown files (posts, pages and parts)
* 'Like an app' layout transitions
* 'Like an app' layout transitions
* Easily restyled through theme object
* Styling with JSS
* Page transitions
* Comments (Facebook)
* Post categories
* Post categories
* Post list filtering
* Full text searching (Algolia)
* Contact form (Netlify form handling)
Expand Down Expand Up @@ -528,7 +528,7 @@ Community:
* Responsive Design, optimized for Mobile devices
* Seo Friendly
* Uses Flexbox

* [gatsby-starter-stellar](https://github.com/codebushi/gatsby-starter-stellar)
[(demo)](http://gatsby-stellar.surge.sh/)

Expand Down
3 changes: 1 addition & 2 deletions docs/docs/graphql-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,10 @@ This query combines sorting, filtering, limiting and formatting together.

<iframe src="https://gatsbygraphql.sloppy.zone/?query=%7B%0A%20%20allMarkdownRemark(%0A%20%20%20%20limit%3A%203%0A%20%20%20%20filter%3A%20%7B%0A%20%20%20%20%20%20frontmatter%3A%20%7Bdate%3A%20%7Bne%3A%20null%7D%7D%0A%20%20%20%20%7D%0A%20%20%20%20sort%3A%20%7Bfields%3A%20%5Bfrontmatter___date%5D%2C%20order%3A%20DESC%7D%0A%20%20)%20%7B%0A%20%20%20%20edges%20%7B%0A%20%20%20%20%20%20node%20%7B%0A%20%20%20%20%20%20%20%20fields%7B%0A%20%20%20%20%20%20%20%20%20%20slug%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%20%20frontmatter%20%7B%0A%20%20%20%20%20%20%20%20%20%20title%0A%20%20%20%20%20%20%20%20%20%20date(formatString%3A%20%22dddd%20DD%20MMMM%20YYYY%22)%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D" width="600" height="400"></iframe>


## Query variables

Work in progress - pull requests welcome.

## Where next?

Try [running your own queries](https://gatsbygraphql.sloppy.zone/?query=%23%20Welcome%20to%20GraphiQL%0A%23%0A%23%20GraphiQL%20is%20an%20in-browser%20tool%20for%20writing%2C%20validating%2C%20and%0A%23%20testing%20GraphQL%20queries.%0A%23%0A%23%20Type%20queries%20into%20this%20side%20of%20the%20screen%2C%20and%20you%20will%20see%20intelligent%0A%23%20typeaheads%20aware%20of%20the%20current%20GraphQL%20type%20schema%20and%20live%20syntax%20and%0A%23%20validation%20errors%20highlighted%20within%20the%20text.%0A%23%0A%23%20GraphQL%20queries%20typically%20start%20with%20a%20%22%7B%22%20character.%20Lines%20that%20starts%0A%23%20with%20a%20%23%20are%20ignored.%0A%23%0A%23%20All%20the%20data%20behind%20gatsbyjs.org%20can%20be%20queried%20from%20here.%20Below%20is%20%0A%23%20an%20example%20query%20to%20get%20you%20started.%0A%23%0A%23%20Keyboard%20shortcuts%3A%0A%23%0A%23%20%20Prettify%20Query%3A%20%20Shift-Ctrl-P%20(or%20press%20the%20prettify%20button%20above)%0A%23%0A%23%20%20%20%20%20%20%20Run%20Query%3A%20%20Ctrl-Enter%20(or%20press%20the%20play%20button%20above)%0A%23%0A%23%20%20%20Auto%20Complete%3A%20%20Ctrl-Space%20(or%20just%20start%20typing)%0A%23%0A%0A%7B%0A%20%20allSitePage(%0A%20%20%20%20limit%3A%205%0A%20%20)%20%7B%0A%20%20%20%20edges%20%7B%0A%20%20%20%20%20%20node%20%7B%0A%20%20%20%20%20%20%20%20path%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D), check out the rest of [the docs](/docs/) or run through [the tutorial](/tutorial/).
Try [running your own queries](<https://gatsbygraphql.sloppy.zone/?query=%23%20Welcome%20to%20GraphiQL%0A%23%0A%23%20GraphiQL%20is%20an%20in-browser%20tool%20for%20writing%2C%20validating%2C%20and%0A%23%20testing%20GraphQL%20queries.%0A%23%0A%23%20Type%20queries%20into%20this%20side%20of%20the%20screen%2C%20and%20you%20will%20see%20intelligent%0A%23%20typeaheads%20aware%20of%20the%20current%20GraphQL%20type%20schema%20and%20live%20syntax%20and%0A%23%20validation%20errors%20highlighted%20within%20the%20text.%0A%23%0A%23%20GraphQL%20queries%20typically%20start%20with%20a%20%22%7B%22%20character.%20Lines%20that%20starts%0A%23%20with%20a%20%23%20are%20ignored.%0A%23%0A%23%20All%20the%20data%20behind%20gatsbyjs.org%20can%20be%20queried%20from%20here.%20Below%20is%20%0A%23%20an%20example%20query%20to%20get%20you%20started.%0A%23%0A%23%20Keyboard%20shortcuts%3A%0A%23%0A%23%20%20Prettify%20Query%3A%20%20Shift-Ctrl-P%20(or%20press%20the%20prettify%20button%20above)%0A%23%0A%23%20%20%20%20%20%20%20Run%20Query%3A%20%20Ctrl-Enter%20(or%20press%20the%20play%20button%20above)%0A%23%0A%23%20%20%20Auto%20Complete%3A%20%20Ctrl-Space%20(or%20just%20start%20typing)%0A%23%0A%0A%7B%0A%20%20allSitePage(%0A%20%20%20%20limit%3A%205%0A%20%20)%20%7B%0A%20%20%20%20edges%20%7B%0A%20%20%20%20%20%20node%20%7B%0A%20%20%20%20%20%20%20%20path%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D>), check out the rest of [the docs](/docs/) or run through [the tutorial](/tutorial/).
4 changes: 2 additions & 2 deletions docs/docs/local-https.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ When setting up a development SSL certificate for the first time, you may be ask

Password:

This is *only* required the first time you are using Gatsby's HTTPS feature on your machine. After that, certificates will be created on the fly.
This is _only_ required the first time you are using Gatsby's HTTPS feature on your machine. After that, certificates will be created on the fly.

After typing in your password, `devcert` will attempt to install some software necessary to tell Firefox (and Chrome, only on Linux) to trust your development certificates.

Expand All @@ -33,6 +33,6 @@ Now open the development server at [https://localhost:8000](https://localhost:80

Find out more about [how devcert works](https://github.com/davewasmer/devcert#how-it-works).

****
---

Keep in mind that the certificates are explicitly issued to `localhost` and will only be accepted there. Using it together with the `--host` option will likely result in browser warnings.
2 changes: 1 addition & 1 deletion docs/docs/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ support, process images, etc.
For larger / complex sites, they let you modularize your site customizations
into site-specific plugins.

Gatsby has a large and growing set of plugins. To search/browse official and
Gatsby has a large and growing set of plugins. To search/browse official and
community plugins and their documentation, visit the [Plugin Library](/packages/).

For information on building your own plugin, see the Plugin Authoring page (/plugin-authoring.md).
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorial/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ This tutorial is for _everyone_! You do not need to be a programmer or React.js

## Advanced tutorials

In these advanced tutorials, you'll learn how to pull data from almost anywhere into your Gatsby site with GraphQL.
In these advanced tutorials, you'll learn how to pull data from almost anywhere into your Gatsby site with GraphQL.

4. [Querying for data in a blog](/tutorial/part-four/): Create a blog and use a GraphQL query to pull your site title into the blog header.
4. [Querying for data in a blog](/tutorial/part-four/): Create a blog and use a GraphQL query to pull your site title into the blog header.
5. [Source plugins and rendering queried data](/tutorial/part-five/): Use a source plugin to pull Markdown blogposts into your site and create an index page with a list of blogposts.
6. [Transformer plugins](/tutorial/part-six/): Use a transformer plugin to transform your Markdown blogposts into a form the blog can render.
7. [Programmatically create pages from data](/tutorial/part-seven/): Learn how to programmatically create a set of pages for your blogposts.
2 changes: 1 addition & 1 deletion docs/tutorial/part-five/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,4 +205,4 @@ And… 😲

## What's coming next?

Now you've learned how source plugins bring data _into_ Gatsby’s data system. In the next tutorial, you'll learn how transformer plugins _transform_ the raw content brought by source plugins. The combination of source plugins and transformer plugins can handle all data sourcing and data transformation you might need when building a Gatsby site. Click here for the [next tutorial to learn about transformer plugins](/tutorial/part-six/).
Now you've learned how source plugins bring data _into_ Gatsby’s data system. In the next tutorial, you'll learn how transformer plugins _transform_ the raw content brought by source plugins. The combination of source plugins and transformer plugins can handle all data sourcing and data transformation you might need when building a Gatsby site. Click here for the [next tutorial to learn about transformer plugins](/tutorial/part-six/).
1 change: 0 additions & 1 deletion docs/tutorial/part-four/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -347,4 +347,3 @@ in our source.
## What's coming next?

Next, you'll be learning about how to pull data into your Gatsby site using GraphQL with source plugins in [part five](/tutorial/part-five/) of the tutorial.

4 changes: 1 addition & 3 deletions docs/tutorial/part-seven/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,5 @@ Now that you've built a Gatsby site, where do you go next?
* Share your Gatsby site on Twitter and see what other people have created by searching for #gatsbytutorial! Make sure to mention @gatsbyjs in your Tweet, and include the hashtag #gatsbytutorial :)
* You could take a look at some [example sites](https://github.com/gatsbyjs/gatsby/tree/master/examples#gatsby-example-websites)
* Explore more [plugins](/docs/plugins/)
* See what [other people are building with Gatsby] (https://github.com/gatsbyjs/gatsby/#showcase)
* See what [other people are building with Gatsby](https://github.com/gatsbyjs/gatsby/#showcase)
* Check out the documentation on [Gatsby's APIs](/docs/api-specification/), [nodes](/docs/node-interface/) or [GraphQL](/docs/graphql-reference/)


4 changes: 2 additions & 2 deletions docs/tutorial/part-six/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ typora-copy-images-to: ./

## What's in this tutorial?

The previous tutorial showed how source plugins bring data _into_ Gatsby’s data system. In this tutorial,you'll learn how transformer plugins _transform_ the raw content brought by source plugins. The combination of source plugins and transformer plugins can handle all data sourcing and data transformation you might need when building a Gatsby site.
The previous tutorial showed how source plugins bring data _into_ Gatsby’s data system. In this tutorial,you'll learn how transformer plugins _transform_ the raw content brought by source plugins. The combination of source plugins and transformer plugins can handle all data sourcing and data transformation you might need when building a Gatsby site.

## Transformer plugins

Expand Down Expand Up @@ -198,4 +198,4 @@ next learn how to _programmatically_ create pages from _data_. Gatsby is _not_
limited to making pages from files like many static site generators. Gatsby lets
you use GraphQL to query your _data_ and _map_ the data to _pages_—all at build
time. This is a really powerful idea. We'll be exploring its implications and
ways to use it in the next tutorial, where you'll learn how to [programmatically create pages from data](/tutorial/part-seven/).
ways to use it in the next tutorial, where you'll learn how to [programmatically create pages from data](/tutorial/part-seven/).
2 changes: 1 addition & 1 deletion docs/tutorial/part-two/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ export default typography;

![typography-lawton](typography-lawton.png)

*Challenge:* Typography.js has more than 30 themes!
_Challenge:_ Typography.js has more than 30 themes!
[Try them live](http://kyleamathews.github.io/typography.js) or check out
[the complete list](https://github.com/KyleAMathews/typography.js#published-typographyjs-themes) and try installing one on your current Gatsby site.

Expand Down
5 changes: 1 addition & 4 deletions examples/using-sass/src/layouts/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@ import PropTypes from "prop-types"

import "../styles/main.scss"

const Layout = ({ children }) =>
<div>
{children()}
</div>
const Layout = ({ children }) => <div>{children()}</div>

Layout.propTypes = {
children: PropTypes.any,
Expand Down
5 changes: 4 additions & 1 deletion examples/using-styled-components/src/html.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,10 @@ class Html extends Component {

<meta name="referrer" content="origin" />
<meta charSet="utf-8" />
<meta name="description" content="Gatsby example site using Styled Components" />
<meta
name="description"
content="Gatsby example site using Styled Components"
/>
<meta httpEquiv="X-UA-Compatible" content="IE=edge" />
<meta
name="viewport"
Expand Down
5 changes: 4 additions & 1 deletion examples/using-styletron/src/html.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,10 @@ class Html extends Component {

<meta name="referrer" content="origin" />
<meta charSet="utf-8" />
<meta name="description" content="Gatsby example site using Styletron" />
<meta
name="description"
content="Gatsby example site using Styletron"
/>
<meta httpEquiv="X-UA-Compatible" content="IE=edge" />
<meta
name="viewport"
Expand Down
6 changes: 3 additions & 3 deletions packages/gatsby-1-config-extract-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ for most use cases.

```javascript
// in gatsby-node.js
const { extractTextPlugin } = require(`gatsby-1-config-extract-plugin`)
const { extractTextPlugin } = require(`gatsby-1-config-extract-plugin`);

exports.modifyWebpackConfig = ({ config, stage }) => {
switch(stage) {
switch (stage) {
case `build-css`: {
loader: extractTextPlugin(stage).extract(`style`, `css`)
loader: extractTextPlugin(stage).extract(`style`, `css`);
}
}
};
Expand Down
4 changes: 2 additions & 2 deletions packages/gatsby-cli/src/reporter/errors.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ function getErrorFormatter() {
"pretty-error": {
marginTop: 1,
},
'pretty-error > header': {
"pretty-error > header": {
background: `red`,
},
'pretty-error > header > colon': {
"pretty-error > header > colon": {
color: `white`,
},
})
Expand Down
7 changes: 3 additions & 4 deletions packages/gatsby-plugin-fullstory/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,9 @@ module.exports = {
{
resolve: `gatsby-plugin-fullstory`,
options: {
fs_org: YOUR_ORG_ID
fs_org: YOUR_ORG_ID,
},
},
]
}
],
};
```

Loading