Skip to content

Commit 59aadf5

Browse files
author
Alexandre Kirszenberg
committed
Merge branch 'master' into topics/multiple-remark-source
2 parents a7f3150 + 4b135de commit 59aadf5

File tree

16 files changed

+351
-20
lines changed

16 files changed

+351
-20
lines changed

docs/docs/recipes.md

Lines changed: 98 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,102 @@
22
title: Recipes
33
---
44

5-
This is a stub. Help our community expand it.
5+
<!-- Basic template:
6+
Task to accomplish.
7+
1-2 sentences about it.
8+
Relevant links out (tutorial, doc pages, plugin readmes, etc).
69
7-
Please use the [Gatsby Style Guide](/docs/gatsby-style-guide/) to ensure your
8-
pull request gets accepted.
10+
Links:
11+
* tutorial link
12+
* docs link
13+
* additional, if needed
14+
15+
And yeah — those three things are exactly what we're thinking. A first step would be to just go through the tutorial and pull out all the basic things we teach there in a condensed form e.g. creating a site, creating a page, linking between pages, etc. -->
16+
17+
Craving a happy medium between doing the [full tutorial](/tutorial/) and crawling the [full docs]((/tutorial/))? Here's a quick guiding reference for how to build things, Gatsby style.
18+
19+
## Table of Contents
20+
- [Using a starter](#using-a-starter)
21+
- [Creating pages](#creating-pages)
22+
- [Linking between pages](#linking-between-pages)
23+
- [Styling](#styling)
24+
- [Creating layouts](#creating-layouts)
25+
- [Deploying](#deploying)
26+
- [Querying data](#querying-data)
27+
- [Sourcing data](#sourcing-data)
28+
- [Transforming data](#transforming-data)
29+
30+
## Using a starter
31+
32+
Starters are boilerplate Gatsby sites maintained officially, or by the community.
33+
34+
* Learn how to use the Gatsby CLI tool to use starters in [tutorial part one](/tutorial/part-one/#using-gatsby-starters)
35+
* See a list of [official and community starters](/docs/gatsby-starters/)
36+
* Check out Gatsby's [official default starter](https://github.com/gatsbyjs/gatsby-starter-default)
37+
38+
## Creating pages
39+
40+
You can create pages in Gatsby explicitly by definining React components in `src/pages/`, or programmatically by using the `createPages` API.
41+
42+
* Walk through creating a page by defining a React component in `src/pages` in [tutorial part one](/tutorial/part-one/#familiarizing-with-gatsby-pages)
43+
* Walk through programmatically creating pages in [tutorial part seven](/tutorial/part-seven/)
44+
* Check out the docs overview on [creating and modifying pages](/docs/creating-and-modifying-pages/)
45+
46+
## Linking between pages
47+
48+
Routing in Gatsby relies on the `<Link />` component, a wrapper around [@reach/router's Link component](https://reach.tech/router/api/Link).
49+
50+
* Walk through using Gatsby's `<Link />` component in [tutorial part one](/tutorial/part-one/#linking-between-pages)
51+
* Learn more about how `<Link />` works [in the docs](/docs/gatsby-link/)
52+
53+
## Styling
54+
There are so many ways to add styles to your website; Gatsby supports almost every possible option, through official and community plugins.
55+
56+
* Walk through adding global styles to an example site in [tutorial part two](/tutorial/part-two/#creating-global-styles)
57+
* More on global styles [with standard CSS files](/docs/creating-global-styles/#how-to-add-global-styles-in-gatsby-with-standard-css-files)
58+
* More on global styles with [CSS-in-JS](/docs/creating-global-styles/#how-to-add-global-styles-in-gatsby-using-css-in-js)
59+
* More on global styles [with CSS files and no layout component](/docs/creating-global-styles/#add-global-styles-with-css-files-and-no-layout-component)
60+
* Use the CSS-in-JS library [Glamor](/docs/glamor/)
61+
* Use the CSS-in-JS library [Styled Components](/docs/styled-components/)
62+
* Use [CSS Modules](/tutorial/part-two/#css-modules)
63+
64+
## Creating layouts
65+
66+
To wrap pages with layouts, use normal React components.
67+
68+
* Walk through creating a layout component in [tutorial part three](/tutorial/part-three/#your-first-layout-component)
69+
* Gatsby v1 approached layouts differently. If the context is helpful, learn about the [differences in v2](/blog/2018-06-08-life-after-layouts/)
70+
71+
## Deploying
72+
73+
Showtime.
74+
75+
* Walk through building and deploying an example site in [tutorial part one](/tutorial/part-one/#deploying-a-gatsby-site)
76+
* Learn how to make sure your site is configured properly to be [searchable, sharable, and properly navigable](/docs/preparing-for-site-launch/)
77+
* Learn about [performance optimization](/docs/performance/)
78+
* Read about [other deployment related topics](/docs/deploying-and-hosting/)
79+
80+
## Querying data
81+
82+
In Gatsby, you access data through a query language called [GraphQL](https://graphql.org/).
83+
84+
* Walk through an example of how Gatsby's data layer [pulls data into components using GraphQL](/tutorial/part-four/#how-gatsbys-data-layer-uses-graphql-to-pull-data-into-components)
85+
* Walk through [using Gatsby's `graphql` tag for page queries](/tutorial/part-five/#build-a-page-with-a-graphql-query)
86+
* Read through a conceptual guide on [querying data with GraphQL in Gatsby](/docs/querying-with-graphql/)
87+
* Learn more about the `graphql` tag -- [querying data in a Gatsby page](/docs/page-query/)
88+
* Learn more about `<StaticQuery />` -- [querying data in (non-page) components](/docs/static-query/)
89+
90+
## Sourcing data
91+
92+
Data sourcing in Gatsby is plugin-driven; Source plugins fetch data from their source (e.g. the `gatsby-source-filesystem` plugin fetches data from the file system, the `gatsby-source-wordpress` plugin fetches data from the WordPress API, etc).
93+
94+
* Walk through an example using the `gatsby-source-filesystem` plugin in [tutorial part five](/tutorial/part-five/#source-plugins)
95+
* Search available source plugins in the [Gatsby library](/plugins/?=source)
96+
* Understand source plugins by building one in the [source plugin tutorial](/docs/source-plugin-tutorial/)
97+
98+
## Transforming data
99+
100+
Transforming data in Gatsby is also plugin-driven; Transformer plugins take data fetched using source plugins, and process it into something more usable (e.g. JSON into JavaScript objects, markdown to HTML, and more).
101+
102+
* Walk through an example using the `gatsby-transformer-remark` plugin to transform markdown files [tutorial part six](/tutorial/part-six/#transformer-plugins)
103+
* Search available transformer plugins in the [Gatsby library](/plugins/?=transformer)

docs/sites.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -644,12 +644,15 @@
644644
- title: The Rick and Morty API
645645
main_url: 'https://rickandmortyapi.com/'
646646
url: 'https://rickandmortyapi.com/'
647+
built_by: Axel Fuhrmann
648+
built_by_url: https://axelfuhrmann.com/
647649
featured: false
648650
categories:
649651
- Web Dev
650652
- Entertainment
651653
- Documentation
652654
- Open Source
655+
- API
653656
- title: Santa Compañía Creativa
654657
main_url: 'https://santacc.es/'
655658
url: 'https://santacc.es/'
@@ -2167,3 +2170,55 @@
21672170
- Software
21682171
- Documentation
21692172
featured: false
2173+
- title: Insights
2174+
main_url: https://justaskusers.com/
2175+
url: https://justaskusers.com/
2176+
description: >
2177+
Insights helps user experience (UX) researchers conduct their research and make sense of the findings.
2178+
categories:
2179+
- User Experience
2180+
- Research
2181+
- Design
2182+
built_by: Just Ask Users
2183+
built_by_url: https://justaskusers.com/
2184+
featured: false
2185+
- title: Tensiq
2186+
main_url: https://tensiq.com
2187+
url: https://tensiq.com
2188+
source_url: https://github.com/Tensiq/tensiq-site
2189+
description: >
2190+
Tensiq is an e-Residency startup, that provides development in cutting-edge technology while delivering secure, resilient, performant solutions.
2191+
categories:
2192+
- Game Dev
2193+
- Web Dev
2194+
- Mobile Dev
2195+
- Agency
2196+
- Open Source
2197+
built_by: Jens
2198+
built_by_url: https://github.com/arrkiin
2199+
featured: false
2200+
- title: SendGrid
2201+
main_url: https://sendgrid.com/docs/
2202+
url: https://sendgrid.com/docs/
2203+
description: >
2204+
SendGrid delivers your transactional and marketing emails through the world's largest cloud-based email delivery platform.
2205+
categories:
2206+
- Technology
2207+
- Tool
2208+
- Software
2209+
- Documentation
2210+
featured: false
2211+
- title: Mintfort
2212+
main_url: https://mintfort.com/
2213+
url: https://mintfort.com/
2214+
source_url: https://github.com/MintFort/mintfort.com
2215+
description: >
2216+
Mintfort, the first crypto-friendly bank account. Store and manage assets on the blockchain.
2217+
categories:
2218+
- Technology
2219+
- Tool
2220+
- Bank
2221+
- Software
2222+
built_by: Axel Fuhrmann
2223+
built_by_url: https://axelfuhrmann.com/
2224+
featured: false

docs/tutorial/part-two/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ Now, all the text font sizes should be slightly bigger. Try changing the
237237
`baseFontSize` to `24px` then `12px`. All elements get resized as their
238238
`font-size` is based on the `baseFontSize`.
239239

240-
_Note that if you use `gatsby-plugin-typography` with the default starter, you'll need to delete the default index.css used by that starter as it overrides the Typography.js CSS_
240+
_Note that if you use `gatsby-plugin-typography` with the default starter, you'll need to delete the default layout.css used by that starter as it overrides the Typography.js CSS_
241241

242242
There are
243243
[many themes available](https://github.com/KyleAMathews/typography.js#published-typographyjs-themes)

examples/gatsbygram/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
"cy:run": "cypress run"
5252
},
5353
"devDependencies": {
54-
"cypress": "^2.1.0",
54+
"cypress": "^3.1.0",
5555
"start-server-and-test": "^1.1.4"
5656
}
5757
}

packages/gatsby-plugin-typescript/CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@
33
All notable changes to this project will be documented in this file.
44
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
55

6+
<a name="2.0.0-rc.1"></a>
7+
8+
# [2.0.0-rc.1](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-typescript/compare/[email protected]@2.0.0-rc.1) (2018-08-21)
9+
10+
**Note:** Version bump only for package gatsby-plugin-typescript
11+
612
<a name="2.0.0-rc.0"></a>
713

814
# [2.0.0-rc.0](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-typescript/compare/gatsby-plugin-typescript@[email protected]) (2018-08-21)
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// noop

packages/gatsby-plugin-typescript/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "gatsby-plugin-typescript",
33
"description": "Adds TypeScript support to Gatsby",
4-
"version": "2.0.0-rc.0",
4+
"version": "2.0.0-rc.1",
55
"author": "Kyle Mathews <[email protected]>",
66
"bugs": {
77
"url": "https://github.com/gatsbyjs/gatsby/issues"

packages/gatsby-plugin-typescript/src/gatsby-node.js

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,25 @@ function onCreateBabelConfig({ actions }, pluginOptions) {
66
})
77
}
88

9+
function onCreateWebpackConfig({ actions, loaders }) {
10+
const jsLoader = loaders.js()
11+
12+
if (!jsLoader) {
13+
return
14+
}
15+
16+
actions.setWebpackConfig({
17+
module: {
18+
rules: [
19+
{
20+
test: /\.tsx?$/,
21+
use: jsLoader,
22+
},
23+
],
24+
},
25+
})
26+
}
27+
928
exports.resolvableExtensions = resolvableExtensions
1029
exports.onCreateBabelConfig = onCreateBabelConfig
30+
exports.onCreateWebpackConfig = onCreateWebpackConfig

packages/gatsby-plugin-typescript/src/resolve.js

Lines changed: 0 additions & 2 deletions
This file was deleted.

packages/gatsby-plugin-typography/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A Gatsby plugin for utilizing the [Typography](https://kyleamathews.github.io/typography.js/) library with minimal configuration.
44

5-
See it in action in the [Tutorial](https://www.gatsbyjs.org/tutorial/part-two/)
5+
See it in action in the [Tutorial](https://www.gatsbyjs.org/tutorial/part-two/#typographyjs)
66
([source](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-typography))
77

88
## Install

0 commit comments

Comments
 (0)