Skip to content
This repository was archived by the owner on Jan 20, 2025. It is now read-only.

Commit 550d393

Browse files
authored
Merge branch 'master' into docs/adding-react-components
2 parents d89ef74 + db4988f commit 550d393

File tree

193 files changed

+2254
-1588
lines changed

Some content is hidden

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

193 files changed

+2254
-1588
lines changed

docs/contributing/blog-and-website-contributions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,6 @@ If you want to make changes, improvements, or add new functionality to the websi
5858

5959
> Note: If you are experiencing issues on a Linux machine, run `sudo apt install libvips-dev`, to install a native dependency. You can also reference [Gatsby guide on Linux](/docs/gatsby-on-linux/) for other Linux-specific requirements.
6060
61-
Now you can make and preview your changes before raising a pull request!
61+
Now you can make and preview your changes before raising a Pull Request!
6262

6363
For full repo setup instructions, visit the [code contributions](/contributing/code-contributions/) page.
Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
---
2-
title: Free Swag for Gatsby Contributors!
2+
title: Gatsby コントリビューターへの無料の景品!
33
---
44

5-
Gatsby relies on contributors from the open source community, and we want to make sure you know how much it means to us that you’re willing to put time and effort into [contributing to Gatsby](/contributing/how-to-contribute/).
5+
Gatsby はオープンソースコミュニティーのコントリビューターに依存しています。[Gatsby への貢献](/contributing/how-to-contribute/)に時間と労力を費やすことが、私たちにとってどれだけ意味があるのかを確認したいと思います。
66

7-
To show our appreciation, _**everyone who contributes to Gatsby is eligible to receive free swag!**_
7+
感謝の証として、 _**Gatsby に貢献した全ての人が無料の景品を受け取ることができます!**_
88

9-
![Gatsby contributors wearing swag.](./images/gatsby-swag.jpg)
9+
![Gatsby の景品を着ているコントリビューター。](./images/gatsby-swag.jpg)
1010

11-
### How to claim your free swag
11+
### 無料の景品を受け取る方法
1212

13-
If you contribute to the Gatsby organization on GitHub, you can claim your swag by [logging into the Gatsby Store](https://store.gatsbyjs.org/) and requesting a discount code. With five or more contributions, you can claim your _**Level 2**_ swag.
13+
GitHub で Gatsby 組織に貢献した場合は [Gatsby Store にログイン](https://store.gatsbyjs.org/)して、割引コードを要求することで景品を受け取れます。5 回以上貢献することで _**レベル2**_ の景品を受け取ることもできます。
1414

15-
If you’ve contributed in other ways, such as giving talks about Gatsby, teaching others to use it, writing Gatsby articles/tutorials, participating in a Gatsby research project, or any other way, please email <mailto:[email protected]> or [tweet at Gatsby on Twitter](https://twitter.com/gatsbyjs) to claim your swag.
15+
別の方法で貢献した場合は <mailto:[email protected]> にメールするか、[Twitter で Gatsby にツイート](https://twitter.com/gatsbyjs)して景品を受け取りましょう。例えば Gatsby について講演したり、Gatsby の使い方を他の人に教えたり、Gatsby の記事やチュートリアルを書いたり、Gatsby の研究プロジェクトへ参加したり、またはその他の方法で貢献した場合です。
1616

17-
### Details about free swag
17+
### 無料の景品の詳細
1818

19-
- We will send one item from our [swag store](https://store.gatsbyjs.org/) per swag tier
20-
- Tier 1 swag includes most items \$10 and under
21-
- Tier 2 swag includes most items \$26 and under
22-
- Not all items are eligible due to high cost to create the swag. We’ll make it clear which items are not eligible
23-
- There’s a limit of one free swag item per swag tier
24-
- Shipping is free worldwide
19+
- [景品ストア](https://store.gatsbyjs.org/) から景品レベルごとに 1 つのアイテムを送ります。
20+
- レベル 1 の景品には、10 ドル以下のほとんどのアイテムが含まれています。
21+
- レベル 2 の景品には、26 ドル以下のほとんどのアイテムが含まれています。
22+
- 景品を作成するのに費用がかかるため、すべてのアイテムが対象となるわけではありません。どのアイテムが対象外なのかを明確にします。
23+
- 無料で受け取ることができるのは、景品レベルごとに 1 つという制限があります。
24+
- 世界中どこでも送料無料です。
2525

26-
> **NOTE:** Worldwide free shipping is a pilot program. If shipping costs get out of control, we may need to adjust this policy in the future.
26+
> **注意:** 世界中への送料無料は試験的なプログラムです。送料が手に負えなくなった場合は、このポリシーを調整する必要があります。

docs/contributing/docs-and-website-components.md

Lines changed: 1 addition & 178 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,6 @@ title: Docs and Website Components
33
tableOfContentsDepth: 2
44
---
55

6-
import LayerModel from "../../www/src/components/layer-model"
7-
import HorizontalNavList from "../../www/src/components/horizontal-nav-list"
8-
import Breadcrumb from "../../www/src/components/docs-breadcrumb"
9-
import { itemListContributing } from "../../www/src/utils/sidebar/item-list"
10-
import TableOfContents from "../../www/src/components/docs-table-of-contents"
11-
126
The Gatsbyjs.org site has a handful of components that have been developed to facilitate writing new content for the blog and the docs. There are also components that help organize and lay out content in various pages across the website.
137

148
This guide documents what components are available and explains how to use them. You can also refer to the [code for this page on GitHub](https://github.com/gatsbyjs/gatsby/blob/master/docs/contributing/docs-and-website-components.md) to see to how each component can be used, because they are all embedded here!
@@ -130,14 +124,6 @@ Rendered, the component looks like this:
130124
To improve is to change, so to be perfect is to have changed often.
131125
</Pullquote>
132126

133-
---
134-
135-
## Other available components
136-
137-
Other less commonly used components aren't globally available, but can imported at the top of a Markdown file and used in other docs.
138-
139-
---
140-
141127
### Layer Model
142128

143129
The `<LayerModel />` was made to help explain concepts of how Gatsby works at a high level. It conceptually breaks Gatsby into different layers and shows how data is pulled, aggregated, and eventually rendered as an app. It's used on docs pages to help explain how Gatsby works at different levels.
@@ -168,7 +154,7 @@ When used, it looks like this:
168154

169155
### Horizontal Navigation List
170156

171-
The `<HorizontalNavList />` was made for the [Glossary](/docs/glossary/), and renders a list of links to alphabetical subheadings on the page in a horizontal format. Because of its specific use case, it isn't made globally available but can be imported if needed on other pages.
157+
The `<HorizontalNavList />` was made for the [Glossary](/docs/glossary/), and renders a list of links to alphabetical subheadings on the page in a horizontal format.
172158

173159
#### Usage
174160

@@ -212,169 +198,6 @@ items={[
212198
slug={props.slug}
213199
/>
214200

215-
### Breadcrumb
216-
217-
The `<Breadcrumb />` component is used in layout files to display the hierarchy of pages a user is currently browsing on.
218-
219-
#### Usage
220-
221-
The Breadcrumb component takes one prop:
222-
223-
- `location` - an object provided in the props of page templates by default
224-
- `itemList` - an object comprised of the docs hierarchical structure
225-
226-
<!-- prettier-ignore -->
227-
```jsx
228-
import Breadcrumb from "../../www/src/components/docs-breadcrumb"
229-
230-
<Breadcrumb location={props.location} itemList={itemList} />
231-
```
232-
233-
_You can also refer to [an example of usage of the Breadcrumb in the Gatsbyjs.org source code](https://github.com/gatsbyjs/gatsby/blob/1d65ce051967dda5c4a89da920fc34692524e237/www/src/templates/template-docs-markdown.js#L82)_
234-
235-
#### Optional `breadcrumbTitle` entries in sidebar files
236-
237-
To alter the title of a doc that is displayed in the Breadcrumb component, a `breadcrumbTitle` is supported as a key in the [sidebar YAML files](https://github.com/gatsbyjs/gatsby/tree/master/www/src/data/sidebars). It is commonly used to provide an abbreviated version of a doc's title when displayed next to its parent page title, e.g. shortening "Adding a Custom webpack Config" to "webpack Config".
238-
239-
#### Sample
240-
241-
Rendered, it looks like this:
242-
243-
<Breadcrumb
244-
location={{
245-
pathname: "/contributing/docs-and-website-components/",
246-
}}
247-
itemList={itemListContributing}
248-
/>
249-
250-
---
251-
252-
### Table of Contents
253-
254-
The `<TableOfContents />` component is used to render a list of subheaders from a docs page and automatically provide deep links to them.
255-
256-
#### Usage
257-
258-
The component takes 2 props:
259-
260-
- `location` - an object provided in the props of page templates by default
261-
- `page` - an object with data passed in from the sites `gatsby-node.js` that contains information from the MDX plugin about the structure of headings
262-
263-
<!-- prettier-ignore -->
264-
```jsx
265-
import TableOfContents from "../../www/src/components/docs-table-of-contents"
266-
267-
<TableOfContents location={props.location} page={page} />
268-
```
269-
270-
_You can also refer to [an example of usage of the Table of Contents in the Gatsbyjs.org source code](https://github.com/gatsbyjs/gatsby/blob/1d65ce051967dda5c4a89da920fc34692524e237/www/src/templates/template-docs-markdown.js#L121)_
271-
272-
The Table of Contents component also has some optional configurations that can be set in the frontmatter of a doc's markdown.
273-
274-
In docs where the Table of Contents isn't required and should be disabled, a key in the frontmatter called `disableTableOfContents` can be set to `true` like this:
275-
276-
```markdown
277-
---
278-
title: Glossary
279-
disableTableOfContents: true
280-
---
281-
282-
When you're new to Gatsby there can be a lot of words to learn...
283-
```
284-
285-
In other docs where the Table of Contents is extremely long it can make sense to only show headers from the doc up to a certain level, rather than all subheadings. You can set the `tableOfContentsDepth` key to a number that will limit the subheadings shown in the table of contents to that "depth". If it is set to 2, `<h2>`/`##`, and `<h3>`/`###` headers will be listed, if set to 3, `<h2>`/`##`, `<h3>`/`###`, and `<h4>`/`####` will all be shown. It is set like this:
286-
287-
```markdown
288-
---
289-
title: Glossary
290-
tableOfContentsDepth: 2
291-
---
292-
293-
When you're new to Gatsby there can be a lot of words to learn...
294-
```
295-
296-
#### Sample
297-
298-
The Table of Contents looks like this when rendered (and is also displayed on the right hand side of the page):
299-
300-
<TableOfContents
301-
location={{ pathname: "/contributing/docs-and-website-components/" }}
302-
page={{
303-
frontmatter: {
304-
title: "Docs and Website Components",
305-
tableOfContentsDepth: 2,
306-
},
307-
tableOfContents: {
308-
items: [
309-
{
310-
url: "#globally-available-components",
311-
title: "Globally available components",
312-
items: [
313-
{
314-
url: "#guide-list",
315-
title: "Guide list",
316-
},
317-
{
318-
url: "#egghead-embed",
319-
title: "Egghead embed",
320-
},
321-
{
322-
url: "#pull-quote",
323-
title: "Pull quote",
324-
},
325-
],
326-
},
327-
{
328-
url: "#other-available-components",
329-
title: "Other available components",
330-
items: [
331-
{
332-
url: "#layer-model",
333-
title: "Layer model",
334-
},
335-
{
336-
url: "#horizontal-navigation-list",
337-
title: "Horizontal navigation list",
338-
},
339-
{
340-
url: "#breadcrumb",
341-
title: "Breadcrumb",
342-
},
343-
{
344-
url: "#table-of-contents",
345-
title: "Table of Contents",
346-
},
347-
],
348-
},
349-
{
350-
url: "#writing-content-in-markdown",
351-
title: "Writing content in markdown",
352-
items: [
353-
{
354-
url: "#code-blocks",
355-
title: "Code blocks",
356-
},
357-
],
358-
},
359-
{
360-
url: "#styling-components-on-gatsbyjsorg-with-theme-ui",
361-
title: "Styling components on Gatsbyjs.org with Theme-UI",
362-
items: [
363-
{
364-
url: "#design-tokens",
365-
title: "Design tokens",
366-
},
367-
{
368-
url: "#the-sx-prop",
369-
title: "The sx prop",
370-
},
371-
],
372-
},
373-
],
374-
},
375-
}}
376-
/>
377-
378201
---
379202

380203
## Writing content in Markdown

0 commit comments

Comments
 (0)