You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 20, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: docs/contributing/blog-and-website-contributions.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,6 +58,6 @@ If you want to make changes, improvements, or add new functionality to the websi
58
58
59
59
> 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.
60
60
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!
62
62
63
63
For full repo setup instructions, visit the [code contributions](/contributing/code-contributions/) page.
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/).
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**_の景品を受け取ることもできます。
14
14
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.
Copy file name to clipboardExpand all lines: docs/contributing/docs-and-website-components.md
+1-178Lines changed: 1 addition & 178 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,12 +3,6 @@ title: Docs and Website Components
3
3
tableOfContentsDepth: 2
4
4
---
5
5
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
-
12
6
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.
13
7
14
8
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:
130
124
To improve is to change, so to be perfect is to have changed often.
131
125
</Pullquote>
132
126
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
-
141
127
### Layer Model
142
128
143
129
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:
168
154
169
155
### Horizontal Navigation List
170
156
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.
172
158
173
159
#### Usage
174
160
@@ -212,169 +198,6 @@ items={[
212
198
slug={props.slug}
213
199
/>
214
200
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
_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".
_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):
0 commit comments