From 60e974a41677d00674f58ffdfd0acc06339c12cc Mon Sep 17 00:00:00 2001 From: Alex Reed Date: Wed, 16 Mar 2022 14:46:08 -0400 Subject: [PATCH] updates per PR feedback --- .../src/__tests__/fixtures/data.json | 2 +- deprecated-packages/gatsby-image/src/index.js | 2 +- .../recipes/gatsby-plugin-layout.mdx | 12 +++++----- .../recipes/gatsby-plugin-react-helmet.mdx | 4 ++-- .../recipes/gatsby-theme-blog-core.mdx | 16 +++++++++----- .../recipes/gatsby-theme-blog.mdx | 9 +++++--- .../recipes/gatsby-theme-notes.mdx | 10 +++++---- .../gatsby-recipes/recipes/pwa.mdx | 4 ++-- .../gatsby-config.js | 2 +- .../using-gatsby-source-graphql/README.md | 2 +- packages/gatsby-design-tokens/CHANGELOG.md | 10 ++++----- packages/gatsby-design-tokens/README.md | 2 -- packages/gatsby-plugin-google-gtag/README.md | 4 ++-- packages/gatsby-plugin-mdx/README.md | 4 ++-- .../src/__tests__/fixtures/public/index.html | 10 ++++----- packages/gatsby-plugin-typescript/README.md | 2 +- packages/gatsby-plugin-typography/README.md | 3 --- .../gatsby-remark-copy-linked-files/README.md | 2 +- .../gatsby-remark-custom-blocks/README.md | 2 +- .../gatsby-remark-embed-snippet/README.md | 4 ++-- packages/gatsby-remark-images/README.md | 2 +- packages/gatsby-remark-katex/README.md | 2 +- packages/gatsby-remark-prismjs/README.md | 2 +- packages/gatsby-source-contentful/README.md | 2 +- packages/gatsby-source-filesystem/README.md | 2 -- packages/gatsby-source-filesystem/index.d.ts | 8 +++---- .../src/gatsby-node.js | 2 +- ...uilding-a-new-site-wordpress-and-gatsby.md | 2 +- packages/gatsby-transformer-sharp/README.md | 2 +- packages/gatsby/CHANGELOG.md | 22 +++++++++---------- 30 files changed, 78 insertions(+), 74 deletions(-) diff --git a/.github/actions/high-priority-prs/src/__tests__/fixtures/data.json b/.github/actions/high-priority-prs/src/__tests__/fixtures/data.json index b1553f20c2718..f42c7fd2b544c 100644 --- a/.github/actions/high-priority-prs/src/__tests__/fixtures/data.json +++ b/.github/actions/high-priority-prs/src/__tests__/fixtures/data.json @@ -7356,7 +7356,7 @@ { "commit": { "authoredDate": "2019-06-03T02:42:32Z", - "message": "Made the doc easier to read\n\n- Moved a lot of sentences into active voice\r\n- Removed unnecessary words and sentences\r\n- Fixed some grammatical errors\r\n- Removed potentially confusing emojis as a literary device\r\n- Split up some long sentences into shorter ones\r\n- Added a link to https://www.gatsbyjs.com/blog/2018-06-08-life-after-layouts/ in the layouts section to help people move from Gatsby's layout behavior in v1\r\n- Capitalized instances of \"Babel\" that were lowercase" + "message": "Made the doc easier to read\n\n- Moved a lot of sentences into active voice\r\n- Removed unnecessary words and sentences\r\n- Fixed some grammatical errors\r\n- Removed potentially confusing emojis as a literary device\r\n- Split up some long sentences into shorter ones\r\n- Added a link to https://www.gatsbyjs.org/blog/2018-06-08-life-after-layouts/ in the layouts section to help people move from Gatsby's layout behavior in v1\r\n- Capitalized instances of \"Babel\" that were lowercase" } }, { diff --git a/deprecated-packages/gatsby-image/src/index.js b/deprecated-packages/gatsby-image/src/index.js index 37533e35a8093..923b344a0c0ce 100644 --- a/deprecated-packages/gatsby-image/src/index.js +++ b/deprecated-packages/gatsby-image/src/index.js @@ -192,7 +192,7 @@ function groupByMedia(imageVariants) { if (without.length > 1 && process.env.NODE_ENV !== `production`) { console.warn( - `We've found ${without.length} sources without a media property. They might be ignored by the browser, see: https://www.gatsbyjs.com/packages/gatsby-image/#art-directing-multiple-images` + `We've found ${without.length} sources without a media property. They might be ignored by the browser, see: https://www.gatsbyjs.com/plugins/gatsby-image/#art-directing-multiple-images` ) } diff --git a/deprecated-packages/gatsby-recipes/recipes/gatsby-plugin-layout.mdx b/deprecated-packages/gatsby-recipes/recipes/gatsby-plugin-layout.mdx index 6f3d01b81fa33..4ccd134e4848c 100644 --- a/deprecated-packages/gatsby-recipes/recipes/gatsby-plugin-layout.mdx +++ b/deprecated-packages/gatsby-recipes/recipes/gatsby-plugin-layout.mdx @@ -1,6 +1,6 @@ # Setup gatsby-plugin-layout -This plugin sets up [gatsby-plugin-layout](https://www.gatsbyjs.com/packages/gatsby-plugin-layout/?=gatsby%20layout), which enables adding components that live above the page components and persist across page changes. +This plugin sets up [gatsby-plugin-layout](https://www.gatsbyjs.com/plugins/gatsby-plugin-layout/?=gatsby%20layout), which enables adding components that live above the page components and persist across page changes. This can be helpful for: @@ -15,24 +15,24 @@ This recipe: Installs necessary NPM packages - + --- Installs the Layout plugin in gatsby-config.js - + --- Writes out a sample layout component to get started with. --- Read more about the documentation for Gatsby Layout Component here: -https://www.gatsbyjs.com/packages/gatsby-plugin-layout/ +https://www.gatsbyjs.com/plugins/gatsby-plugin-layout/ diff --git a/deprecated-packages/gatsby-recipes/recipes/gatsby-plugin-react-helmet.mdx b/deprecated-packages/gatsby-recipes/recipes/gatsby-plugin-react-helmet.mdx index 37866a98e2c0d..eee1f4b9c9e3d 100644 --- a/deprecated-packages/gatsby-recipes/recipes/gatsby-plugin-react-helmet.mdx +++ b/deprecated-packages/gatsby-recipes/recipes/gatsby-plugin-react-helmet.mdx @@ -4,7 +4,7 @@ React Helmet is a reusable React component that manages all of your changes to t Helmet takes plain HTML tags and outputs plain HTML tags. -[gatsby-plugin-helmet](https://www.gatsbyjs.com/packages/gatsby-plugin-react-helmet/?=react%20helmet) makes it easy to use React Helmet inside Gatsby projects as it automatically adds title and meta tags to the HTML during SSR. +[gatsby-plugin-helmet](https://www.gatsbyjs.com/plugins/gatsby-plugin-react-helmet/?=react%20helmet) makes it easy to use React Helmet inside Gatsby projects as it automatically adds title and meta tags to the HTML during SSR. This recipe: @@ -33,7 +33,7 @@ Writes out an `` component which helps ensure pages have the necessary titl --- Read more about Gatsby React Helmet here: -https://www.gatsbyjs.com/packages/gatsby-plugin-react-helmet +https://www.gatsbyjs.com/plugins/gatsby-plugin-react-helmet You can also read about the "SEO" component here: https://www.gatsbyjs.com/docs/add-seo-component/ diff --git a/deprecated-packages/gatsby-recipes/recipes/gatsby-theme-blog-core.mdx b/deprecated-packages/gatsby-recipes/recipes/gatsby-theme-blog-core.mdx index 60816bb94a0db..913c19740c920 100644 --- a/deprecated-packages/gatsby-recipes/recipes/gatsby-theme-blog-core.mdx +++ b/deprecated-packages/gatsby-recipes/recipes/gatsby-theme-blog-core.mdx @@ -1,6 +1,6 @@ # Gatsby Theme Blog Core Starter Recipe -[Gatsby theme blog core](https://www.gatsbyjs.com/packages/gatsby-theme-blog-core/) is a great theme for adding blog functionality to your site. It's designed to handle sourcing your blog data for you so you can style it however you like. +[Gatsby theme blog core](https://www.gatsbyjs.com/plugins/gatsby-theme-blog-core/) is a great theme for adding blog functionality to your site. It's designed to handle sourcing your blog data for you so you can style it however you like. This recipe: @@ -14,14 +14,20 @@ Installs necessary NPM packages. Installs the `gatsby-theme-blog-core` plugin in `gatsby-config.js` and makes use of the `basePath` configuration so the blog listing appears at `/blog`. - + --- -Adds some posts. +Adds some posts. - - + + --- diff --git a/deprecated-packages/gatsby-recipes/recipes/gatsby-theme-blog.mdx b/deprecated-packages/gatsby-recipes/recipes/gatsby-theme-blog.mdx index 35b32ded45266..77707843f8132 100644 --- a/deprecated-packages/gatsby-recipes/recipes/gatsby-theme-blog.mdx +++ b/deprecated-packages/gatsby-recipes/recipes/gatsby-theme-blog.mdx @@ -1,6 +1,6 @@ # Setup Gatsby Theme Blog -[Gatsby theme blog](https://www.gatsbyjs.com/packages/gatsby-theme-blog/) is a great theme for adding blog functionality to your site. +[Gatsby theme blog](https://www.gatsbyjs.com/plugins/gatsby-theme-blog/) is a great theme for adding blog functionality to your site. This recipe: @@ -15,13 +15,16 @@ Installs necessary NPM packages. Installs the `gatsby-theme-blog` plugin in `gatsby-config.js` and makes use of the `basePath` configuration so the blog listing appears at `/blog`. - + --- Adds a post. - + --- diff --git a/deprecated-packages/gatsby-recipes/recipes/gatsby-theme-notes.mdx b/deprecated-packages/gatsby-recipes/recipes/gatsby-theme-notes.mdx index 2a92d09e5884d..160e06dadcec5 100644 --- a/deprecated-packages/gatsby-recipes/recipes/gatsby-theme-notes.mdx +++ b/deprecated-packages/gatsby-recipes/recipes/gatsby-theme-notes.mdx @@ -1,6 +1,6 @@ # Gatsby Theme Notes Starter Recipe -[Gatsby theme notes](https://www.gatsbyjs.com/packages/gatsby-theme-notes) is a great theme for adding learning notes to your site. +[Gatsby theme notes](https://www.gatsbyjs.com/plugins/gatsby-theme-notes) is a great theme for adding learning notes to your site. This recipe: @@ -14,13 +14,16 @@ Installs necessary NPM package. Installs the `gatsby-theme-notes` plugin in `gatsby-config.js`. - + --- Adds a note. - + --- @@ -29,4 +32,3 @@ After installing this recipe, you can use your site for notetaking. When you've finished installing the recipe, run `gatsby develop` and check out `http://localhost:8000/notes` for the list of notes. --- - diff --git a/deprecated-packages/gatsby-recipes/recipes/pwa.mdx b/deprecated-packages/gatsby-recipes/recipes/pwa.mdx index 232939ade4d8b..dc2019a79b7be 100644 --- a/deprecated-packages/gatsby-recipes/recipes/pwa.mdx +++ b/deprecated-packages/gatsby-recipes/recipes/pwa.mdx @@ -50,5 +50,5 @@ After running this recipe, your site will be a PWA. Refer to the documentation for the manifest & offline plugins if there are any other edits you'd like to make. -- https://www.gatsbyjs.com/packages/gatsby-plugin-manifest -- https://www.gatsbyjs.com/packages/gatsby-plugin-offline +- https://www.gatsbyjs.com/plugins/gatsby-plugin-manifest +- https://www.gatsbyjs.com/plugins/gatsby-plugin-offline diff --git a/deprecated-packages/gatsby-recipes/src/providers/gatsby/fixtures/gatsby-starter-hello-world/gatsby-config.js b/deprecated-packages/gatsby-recipes/src/providers/gatsby/fixtures/gatsby-starter-hello-world/gatsby-config.js index 8975d05ac7798..ccf4e9671b419 100644 --- a/deprecated-packages/gatsby-recipes/src/providers/gatsby/fixtures/gatsby-starter-hello-world/gatsby-config.js +++ b/deprecated-packages/gatsby-recipes/src/providers/gatsby/fixtures/gatsby-starter-hello-world/gatsby-config.js @@ -1,7 +1,7 @@ /** * Configure your Gatsby site with this file. * - * See: https://www.gatsbyjs.com/docs/gatsby-config/ + * See: https://www.gatsbyjs.org/docs/gatsby-config/ */ module.exports = { /* Your site config here */ diff --git a/examples/using-gatsby-source-graphql/README.md b/examples/using-gatsby-source-graphql/README.md index 00b514c7871c0..cbc10a0747825 100644 --- a/examples/using-gatsby-source-graphql/README.md +++ b/examples/using-gatsby-source-graphql/README.md @@ -2,7 +2,7 @@ Simple gatsby site that displays blog with data inside GraphCMS. -Built using [gatsby-source-graphql](https://www.gatsbyjs.com/packages/gatsby-source-graphql/). +Built using [gatsby-source-graphql](https://www.gatsbyjs.com/plugins/gatsby-source-graphql/). diff --git a/packages/gatsby-design-tokens/CHANGELOG.md b/packages/gatsby-design-tokens/CHANGELOG.md index 2f85f3d48ec8d..8e0907bd0b704 100644 --- a/packages/gatsby-design-tokens/CHANGELOG.md +++ b/packages/gatsby-design-tokens/CHANGELOG.md @@ -343,8 +343,8 @@ Here's all changes listed by "token group": - add `colors.whiteFade[5]` - BREAKING CHANGE: fix `colors.blackFade[80]`, `colors.whiteFade[80]` - both were set to an opacity of `.85`, adjusted to `.8` - - TODO: Adjust a couple of values for gatsbyjs.com; no clue about where we currently might use this in `gatsby-interface` and related (.com/Cloud dashboard). -- feat: port `colors.code` from the gatsbyjs.com `theme-ui` theme to the `colors` tokens + - TODO: Adjust a couple of values for gatsbyjs.org; no clue about where we currently might use this in `gatsby-interface` and related (.com/Cloud dashboard). +- feat: port `colors.code` from the gatsbyjs.org `theme-ui` theme to the `colors` tokens - 💚 This improves compliance with WCAG 2.0 AA color contrasts. - feat: add `colors.code.copyButton` - feat: add `colors.code.lineHighlightBackground` @@ -384,7 +384,7 @@ Here's all changes listed by "token group": ##### `sizes` - BREAKING CHANGE: removed - - As discussed in https://github.com/gatsby-inc/gatsby-interface/issues/181, this moves the current gatsbyjs.com-centric `sizes` tokens to `theme-gatsbyjs-org` for clarity, until a clear pattern emerges. + - As discussed in https://github.com/gatsby-inc/gatsby-interface/issues/181, this moves the current gatsbyjs.org-centric `sizes` tokens to `theme-gatsbyjs-org` for clarity, until a clear pattern emerges. ##### `space` @@ -402,11 +402,11 @@ Here's all changes listed by "token group": ##### `zIndices` - BREAKING CHANGE: removed - - As discussed in https://github.com/gatsby-inc/gatsby-interface/issues/181, this moves the current gatsbyjs.com-centric `zIndices` tokens to `theme-gatsbyjs-org`for clarity, until a clear pattern emerges. + - As discussed in https://github.com/gatsby-inc/gatsby-interface/issues/181, this moves the current gatsbyjs.org-centric `zIndices` tokens to `theme-gatsbyjs-org`for clarity, until a clear pattern emerges. #### Themes -- feat: add base `theme-ui` Gatsby theme, gatsbyjs.com `theme-ui` theme +- feat: add base `theme-ui` Gatsby theme, gatsbyjs.org `theme-ui` theme - Both themes don't tree-shake yet, so no `agadoo` yet in the corresponding `gatsby-design-tokens/package.json` scripts. - Both export the `theme-ui` theme as `theme` and also provide individual token group exports (because we require them in `www` for usage outside of the `theme-ui` context). - Example usage: diff --git a/packages/gatsby-design-tokens/README.md b/packages/gatsby-design-tokens/README.md index c446c82c7d29b..8b859b86f19a1 100644 --- a/packages/gatsby-design-tokens/README.md +++ b/packages/gatsby-design-tokens/README.md @@ -100,8 +100,6 @@ import { - `rem` values are based on a `font-size` of `16px` for the root element. - All tokens work in the context of [Theme UI's Theme Scales](https://theme-ui.com/theme-spec/#theme-scales), with the exception of `breakpoints`: Use `breakpointsArray` for `theme-ui` and its [responsive styles](https://theme-ui.com/getting-started/#responsive-styles) feature. -Find a work-in-progress list of design tokens in the design tokens documentation at [gatsbyjs.com/guidelines/design-tokens](https://www.gatsbyjs.com/guidelines/design-tokens/). - ## `theme-ui` themes 🎨 ### `theme` diff --git a/packages/gatsby-plugin-google-gtag/README.md b/packages/gatsby-plugin-google-gtag/README.md index 339e82a9902b0..6cd023189ccfd 100644 --- a/packages/gatsby-plugin-google-gtag/README.md +++ b/packages/gatsby-plugin-google-gtag/README.md @@ -4,7 +4,7 @@ Easily add Google Global Site Tag to your Gatsby site. > The global site tag (gtag.js) is a JavaScript tagging framework and API that allows you to send event data to Google Analytics, Google Ads, Campaign Manager, Display & Video 360, and Search Ads 360. -Global site tag (gtag.js) is meant to combine multiple Google tagging systems and can replace older ones such as [analytics.js](https://developers.google.com/analytics/devguides/collection/analyticsjs/) ([gatsby-plugin-google-analytics](https://www.gatsbyjs.com/packages/gatsby-plugin-google-analytics/)). +Global site tag (gtag.js) is meant to combine multiple Google tagging systems and can replace older ones such as [analytics.js](https://developers.google.com/analytics/devguides/collection/analyticsjs/) ([gatsby-plugin-google-analytics](https://www.gatsbyjs.com/plugins/gatsby-plugin-google-analytics/)). For more general information on gtag you can read Google's official documentation on the subject: https://developers.google.com/gtagjs/. @@ -89,7 +89,7 @@ import { OutboundLink } from "gatsby-plugin-google-gtag" export default () => (
- + Visit the Google Global Site Tag plugin page!
diff --git a/packages/gatsby-plugin-mdx/README.md b/packages/gatsby-plugin-mdx/README.md index 6933163698d5e..62388d19c9b4b 100644 --- a/packages/gatsby-plugin-mdx/README.md +++ b/packages/gatsby-plugin-mdx/README.md @@ -317,12 +317,12 @@ Here's a YouTube embed This config option is used for compatibility with a set of plugins many people [use with remark](https://www.gatsbyjs.com/plugins/?=gatsby-remark-) that require the gatsby environment to function properly. In some cases, like -[gatsby-remark-prismjs](https://www.gatsbyjs.com/packages/gatsby-remark-prismjs/?=gatsby-remark-), +[gatsby-remark-prismjs](https://www.gatsbyjs.com/plugins/gatsby-remark-prismjs/?=gatsby-remark-), it makes more sense to use a library like [prism-react-renderer](https://github.com/FormidableLabs/prism-react-renderer) to render codeblocks using a [React component](/api-reference/mdx-provider). In other cases, like -[gatsby-remark-images](https://www.gatsbyjs.com/packages/gatsby-remark-images/?=gatsby-remark-), +[gatsby-remark-images](https://www.gatsbyjs.com/plugins/gatsby-remark-images/?=gatsby-remark-), the interaction with the Gatsby APIs is well deserved because the images can be optimized by Gatsby and you should continue using it. diff --git a/packages/gatsby-plugin-offline/src/__tests__/fixtures/public/index.html b/packages/gatsby-plugin-offline/src/__tests__/fixtures/public/index.html index 1e5028d179543..53b9025bf0c93 100644 --- a/packages/gatsby-plugin-offline/src/__tests__/fixtures/public/index.html +++ b/packages/gatsby-plugin-offline/src/__tests__/fixtures/public/index.html @@ -60,11 +60,11 @@ - - + + - + @@ -872,7 +872,7 @@

Modern Development, for the Content Web

Fast sites. Fast iterations. Unlike your CMS, Gatsby engineers the development experience for performance.

+
Get started todayWhy Gatsby?
800+ contributors, 24.2 k stars @@ -1150,7 +1150,7 @@

Product

Why Gatsby?

How It Works

Bring Data From AnywhereWrite Modern AppsUnreal PerformanceOne-Click DeploymentAll Guides
-

Docs & Help

DocumentationTutorialBlogCommunity
+

Docs & Help

DocumentationTutorialBlogCommunity

Company

About UsSupportTraining
diff --git a/packages/gatsby-plugin-typescript/README.md b/packages/gatsby-plugin-typescript/README.md index 852d98762d657..06406d3bbfc22 100644 --- a/packages/gatsby-plugin-typescript/README.md +++ b/packages/gatsby-plugin-typescript/README.md @@ -58,7 +58,7 @@ compiler is not involved, the following applies: > and import x, {y} from "z". > > Does not support baseUrl. -> Workaround: use [gatsby-plugin-root-import](https://www.gatsbyjs.com/packages/gatsby-plugin-root-import/) +> Workaround: use [gatsby-plugin-root-import](https://www.gatsbyjs.com/plugins/gatsby-plugin-root-import/) > and configure it to point the baseUrl value (also set baseUrl option in tsconfig.json file). https://babeljs.io/docs/en/babel-plugin-transform-typescript.html diff --git a/packages/gatsby-plugin-typography/README.md b/packages/gatsby-plugin-typography/README.md index 613af43ffe682..bb3fcfe448258 100644 --- a/packages/gatsby-plugin-typography/README.md +++ b/packages/gatsby-plugin-typography/README.md @@ -2,9 +2,6 @@ A Gatsby plugin for utilizing the [Typography](https://kyleamathews.github.io/typography.js/) library with minimal configuration. -See it in action in the [Tutorial](https://www.gatsbyjs.com/tutorial/part-3/) -([source](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-typography)) - ## Install `npm install gatsby-plugin-typography react-typography typography` diff --git a/packages/gatsby-remark-copy-linked-files/README.md b/packages/gatsby-remark-copy-linked-files/README.md index 39ac3a4e03aed..5f18d3d3cad30 100644 --- a/packages/gatsby-remark-copy-linked-files/README.md +++ b/packages/gatsby-remark-copy-linked-files/README.md @@ -30,7 +30,7 @@ The `my-awesome-pdf.pdf` file will be copied to the root directory (i.e., `publi **Default settings:** -Add `gatsby-remark-copy-linked-files` plugin as a plugin to [`gatsby-transformer-remark`](https://www.gatsbyjs.com/packages/gatsby-transformer-remark/): +Add `gatsby-remark-copy-linked-files` plugin as a plugin to [`gatsby-transformer-remark`](https://www.gatsbyjs.com/plugins/gatsby-transformer-remark/): ```javascript // In your gatsby-config.js diff --git a/packages/gatsby-remark-custom-blocks/README.md b/packages/gatsby-remark-custom-blocks/README.md index daa1fbd488606..3e7d1e520f156 100644 --- a/packages/gatsby-remark-custom-blocks/README.md +++ b/packages/gatsby-remark-custom-blocks/README.md @@ -11,7 +11,7 @@ Adds custom blocks to `MarkdownRemark` using [remark-custom-blocks](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-custom-blocks). -Unlike in [gatsby-remark-component](https://www.gatsbyjs.com/packages/gatsby-remark-component/) where you can only use HTML within the custom component tag, custom blocks allow you to use markdown within the block. +Unlike in [gatsby-remark-component](https://www.gatsbyjs.com/plugins/gatsby-remark-component/) where you can only use HTML within the custom component tag, custom blocks allow you to use markdown within the block. ## Install diff --git a/packages/gatsby-remark-embed-snippet/README.md b/packages/gatsby-remark-embed-snippet/README.md index 80431cca8ac90..00605410070ae 100644 --- a/packages/gatsby-remark-embed-snippet/README.md +++ b/packages/gatsby-remark-embed-snippet/README.md @@ -4,7 +4,7 @@ Embeds the contents of specified files as code snippets. ## Installation -**Note**: This plugin depends on [gatsby-remark-prismjs](https://www.gatsbyjs.com/packages/gatsby-remark-prismjs/) and [gatsby-transformer-remark](https://www.gatsbyjs.com/packages/gatsby-transformer-remark/) plugins +**Note**: This plugin depends on [gatsby-remark-prismjs](https://www.gatsbyjs.com/plugins/gatsby-remark-prismjs/) and [gatsby-transformer-remark](https://www.gatsbyjs.com/plugins/gatsby-transformer-remark/) plugins ```shell npm install gatsby-remark-embed-snippet gatsby-remark-prismjs gatsby-transformer-remark prismjs @@ -14,7 +14,7 @@ npm install gatsby-remark-embed-snippet gatsby-remark-prismjs gatsby-transformer > **Important**: _You must add `gatsby-remark-embed-snippet` before `gatsby-remark-prismjs` in your plugins array!_ > Otherwise, this plugin will not work because the code snippet files first need to be inlined before they can be transformed into code blocks. -> For more information, see [gatsby-remark-prismjs](https://www.gatsbyjs.com/packages/gatsby-remark-prismjs/). +> For more information, see [gatsby-remark-prismjs](https://www.gatsbyjs.com/plugins/gatsby-remark-prismjs/). To use `gatsby-remark-embed-snippet` plugin: diff --git a/packages/gatsby-remark-images/README.md b/packages/gatsby-remark-images/README.md index b50a0c907230a..f34c9a50de3c0 100644 --- a/packages/gatsby-remark-images/README.md +++ b/packages/gatsby-remark-images/README.md @@ -96,7 +96,7 @@ This plugin will support the following formats: - JPEG - PNG -Since [Sharp][5] is used for image processing, this plugin will not support GIFs or SVGs. If you would like to render these file types with the image markdown syntax, use the [`gatsby-remark-copy-linked-files`](https://www.gatsbyjs.com/packages/gatsby-remark-copy-linked-files/) plugin. Do note with this it will load in the images, but won't use the features of [Sharp][5] such as the elastic container or the blur-up enhancements. +Since [Sharp][5] is used for image processing, this plugin will not support GIFs or SVGs. If you would like to render these file types with the image markdown syntax, use the [`gatsby-remark-copy-linked-files`](https://www.gatsbyjs.com/plugins/gatsby-remark-copy-linked-files/) plugin. Do note with this it will load in the images, but won't use the features of [Sharp][5] such as the elastic container or the blur-up enhancements. [1]: https://jmperezperez.com/medium-image-progressive-loading-placeholder/ [2]: https://code.facebook.com/posts/991252547593574/the-technology-behind-preview-photos/ diff --git a/packages/gatsby-remark-katex/README.md b/packages/gatsby-remark-katex/README.md index a19ffdb35aa1b..82d41e0139e32 100644 --- a/packages/gatsby-remark-katex/README.md +++ b/packages/gatsby-remark-katex/README.md @@ -58,7 +58,7 @@ a^2 + b^2 = c^2 $$ ``` -[1]: https://www.gatsbyjs.com/packages/gatsby-remark-katex/ +[1]: https://www.gatsbyjs.com/plugins/gatsby-remark-katex/ [2]: https://github.com/Rokt33r/remark-math [3]: https://github.com/KaTeX/KaTeX [4]: https://github.com/gatsbyjs/gatsby/blob/master/examples/using-remark/src/templates/template-blog-post.js diff --git a/packages/gatsby-remark-prismjs/README.md b/packages/gatsby-remark-prismjs/README.md index 1a66bf4868cc6..02b57cd0b0dbe 100644 --- a/packages/gatsby-remark-prismjs/README.md +++ b/packages/gatsby-remark-prismjs/README.md @@ -400,7 +400,7 @@ You can specify language for `diff` code blocks by using `diff-[language]` to en ### Line hiding -As well as highlighting lines, it's possible to _hide_ lines from the rendered output. Often this is handy when using `gatsby-remark-prismjs` along with [`gatsby-remark-embed-snippet`](https://www.gatsbyjs.com/packages/gatsby-remark-embed-snippet/). +As well as highlighting lines, it's possible to _hide_ lines from the rendered output. Often this is handy when using `gatsby-remark-prismjs` along with [`gatsby-remark-embed-snippet`](https://www.gatsbyjs.com/plugins/gatsby-remark-embed-snippet/). As with highlighting lines, you can control which lines to hide by adding directives as comments in your source code. diff --git a/packages/gatsby-source-contentful/README.md b/packages/gatsby-source-contentful/README.md index 027d9a7d08905..8463df758e773 100644 --- a/packages/gatsby-source-contentful/README.md +++ b/packages/gatsby-source-contentful/README.md @@ -263,7 +263,7 @@ On Contentful, a "Long text" field uses Markdown by default. The field is expose } ``` -Unless the text is Markdown-free, you cannot use the returned value directly. In order to handle the Markdown content, you must use a transformer plugin such as [`gatsby-transformer-remark`](https://www.gatsbyjs.com/packages/gatsby-transformer-remark/). The transformer will create a `childMarkdownRemark` on the "Long text" field and expose the generated html as a child node: +Unless the text is Markdown-free, you cannot use the returned value directly. In order to handle the Markdown content, you must use a transformer plugin such as [`gatsby-transformer-remark`](https://www.gatsbyjs.com/plugins/gatsby-transformer-remark/). The transformer will create a `childMarkdownRemark` on the "Long text" field and expose the generated html as a child node: ```graphql { diff --git a/packages/gatsby-source-filesystem/README.md b/packages/gatsby-source-filesystem/README.md index 2501bbe147393..41d3a45538bb3 100644 --- a/packages/gatsby-source-filesystem/README.md +++ b/packages/gatsby-source-filesystem/README.md @@ -130,8 +130,6 @@ createFilePath({ #### Example usage -The following is taken from [Gatsby Tutorial, Part Seven](https://www.gatsbyjs.com/tutorial/part-7/) and is used to create URL slugs for markdown pages. - ```javascript const { createFilePath } = require(`gatsby-source-filesystem`) diff --git a/packages/gatsby-source-filesystem/index.d.ts b/packages/gatsby-source-filesystem/index.d.ts index b2e78493450c6..2d578b9e1a3da 100644 --- a/packages/gatsby-source-filesystem/index.d.ts +++ b/packages/gatsby-source-filesystem/index.d.ts @@ -1,19 +1,19 @@ import { Node, Store, NodePluginArgs } from "gatsby" /** - * @see https://www.gatsbyjs.com/packages/gatsby-source-filesystem/?=files#createfilepath + * @see https://www.gatsbyjs.com/plugins/gatsby-source-filesystem/?=files#createfilepath */ export function createFilePath(args: CreateFilePathArgs): string /** - * @see https://www.gatsbyjs.com/packages/gatsby-source-filesystem/?=files#createremotefilenode + * @see https://www.gatsbyjs.com/plugins/gatsby-source-filesystem/?=files#createremotefilenode */ export function createRemoteFileNode( args: CreateRemoteFileNodeArgs ): Promise /** - * @see https://www.gatsbyjs.com/packages/gatsby-source-filesystem/?=files#createfilenodefrombuffer + * @see https://www.gatsbyjs.com/plugins/gatsby-source-filesystem/?=files#createfilenodefrombuffer */ export function createFileNodeFromBuffer( args: CreateFileNodeFromBufferArgs @@ -103,7 +103,7 @@ export interface FileSystemConfig { } /** - * @see https://www.gatsbyjs.com/packages/gatsby-source-filesystem/?=filesy#options + * @see https://www.gatsbyjs.com/plugins/gatsby-source-filesystem/?=filesy#options */ interface FileSystemOptions { name: string diff --git a/packages/gatsby-source-filesystem/src/gatsby-node.js b/packages/gatsby-source-filesystem/src/gatsby-node.js index 4bbe8dc5988de..8a2d70003962d 100644 --- a/packages/gatsby-source-filesystem/src/gatsby-node.js +++ b/packages/gatsby-source-filesystem/src/gatsby-node.js @@ -171,7 +171,7 @@ exports.sourceNodes = (api, pluginOptions) => { The path passed to gatsby-source-filesystem does not exist on your file system: ${pluginOptions.path} Please pick a path to an existing directory. -See docs here - https://www.gatsbyjs.com/packages/gatsby-source-filesystem/ +See docs here - https://www.gatsbyjs.com/plugins/gatsby-source-filesystem/ `) } diff --git a/packages/gatsby-source-wordpress/docs/tutorials/building-a-new-site-wordpress-and-gatsby.md b/packages/gatsby-source-wordpress/docs/tutorials/building-a-new-site-wordpress-and-gatsby.md index 2577382046ed8..cdd61eed9f606 100644 --- a/packages/gatsby-source-wordpress/docs/tutorials/building-a-new-site-wordpress-and-gatsby.md +++ b/packages/gatsby-source-wordpress/docs/tutorials/building-a-new-site-wordpress-and-gatsby.md @@ -13,7 +13,7 @@ gatsby new wordpress-tutorial-site cd wordpress-tutorial-site ``` -Install the `gatsby-source-wordpress` plugin. For extra reading on the plugin’s features and examples of GraphQL queries not included in this tutorial, see the [`gatsby-source-wordpress` plugin’s README file](https://www.gatsbyjs.com/packages/gatsby-source-wordpress). +Install the `gatsby-source-wordpress` plugin. For extra reading on the plugin’s features and examples of GraphQL queries not included in this tutorial, see the [`gatsby-source-wordpress` plugin’s README file](https://www.gatsbyjs.com/plugins/gatsby-source-wordpress). ```shell npm install gatsby-source-wordpress diff --git a/packages/gatsby-transformer-sharp/README.md b/packages/gatsby-transformer-sharp/README.md index 38c1ed6806bd0..05474cc9db7ea 100644 --- a/packages/gatsby-transformer-sharp/README.md +++ b/packages/gatsby-transformer-sharp/README.md @@ -23,7 +23,7 @@ module.exports = { Please note that you must have a source plugin (which brings in images) installed in your project. Otherwise, no `ImageSharp` nodes can be created for your files. Examples would be [`gatsby-source-filesystem`](/plugins/gatsby-source-filesystem) or source plugins for (headless) CMSs like [`gatsby-source-wordpress`](/plugins/gatsby-source-wordpress). -**Note**: An exception to this is when using [`gatsby-source-contentful`](/plugins/gatsby-source-contentful/), as the source plugin and the assets are not [downloaded to the local filesystem](https://www.gatsbyjs.com/packages/gatsby-source-contentful/#download-assets-for-static-distribution). By default, the `gatsby-source-contentful` plugin creates a `ContentfulAsset` node for every image with links to Contentful’s CDN, therefore it is not necessary to use `gatsby-transformer-sharp` together with `gatsby-source-contentful`. +**Note**: An exception to this is when using [`gatsby-source-contentful`](/plugins/gatsby-source-contentful/), as the source plugin and the assets are not [downloaded to the local filesystem](https://www.gatsbyjs.com/plugins/gatsby-source-contentful/#download-assets-for-static-distribution). By default, the `gatsby-source-contentful` plugin creates a `ContentfulAsset` node for every image with links to Contentful’s CDN, therefore it is not necessary to use `gatsby-transformer-sharp` together with `gatsby-source-contentful`. ## Parsing algorithm diff --git a/packages/gatsby/CHANGELOG.md b/packages/gatsby/CHANGELOG.md index 116289a6f9f10..44d01af447c62 100644 --- a/packages/gatsby/CHANGELOG.md +++ b/packages/gatsby/CHANGELOG.md @@ -7635,7 +7635,7 @@ Our first beta!!! 🎉 ### Added - Allow for gatsby-remark-smartypants options #1166 @mitchejj -- New design (for gatsbyjs.com) + new home page #1170 @kyleamathews +- New design (for gatsbyjs.org) + new home page #1170 @kyleamathews - Add ability to locally define plugins #1126 @0x80 - Add rough draft for docs for creating source plugins #1159 @kyleamathews - Optimizations around prefetching page resources #1133 @kyleamathews @@ -7705,45 +7705,45 @@ Our first beta!!! 🎉 - Add new plugin for extracting JSDocs information from JavaScript files using documentation.js #1053 @kyleamathews - Add new API spec (rough draft) @kyleamathews - https://www.gatsbyjs.com/docs/api-specification/ + https://www.gatsbyjs.org/docs/api-specification/ - Add new API reference pages @kyleamathews e.g. - https://www.gatsbyjs.com/docs/node-apis/ + https://www.gatsbyjs.org/docs/node-apis/ - Add "duotone" image processing option to gatsby-plugin-sharp #1047 @fk - Add example site for image processing @fk https://image-processing.gatsbyjs.org/ - Add example site for css-in-js library Glamor @kyleamathews - https://using-glamor.gatsbyjs.com/ + https://using-glamor.gatsbyjs.org/ - Add example site for css-in-js library Styled Components @kyleamathews https://using-styled-components.gatsbyjs.org/ ### Changed -#### Grand big API renaming based on our new API spec https://www.gatsbyjs.com/docs/api-specification/ +#### Grand big API renaming based on our new API spec https://www.gatsbyjs.org/docs/api-specification/ API changes: -[Action creators](https://www.gatsbyjs.com/docs/bound-action-creators/): +[Action creators](https://www.gatsbyjs.org/docs/bound-action-creators/): - `upsertPage` is now `createPage` - `addFieldToNode` is now `createNodeField` - `deletePageByPath` is now `deletePage` - `addNodeToParent` is now `createParentChildLink` -[gatsby-browser.js APIs](https://www.gatsbyjs.com/docs/browser-apis/): +[gatsby-browser.js APIs](https://www.gatsbyjs.org/docs/browser-apis/): - `clientEntry` is now `onClientEntry` -[gatsby-node.js APIs](https://www.gatsbyjs.com/docs/node-apis/): +[gatsby-node.js APIs](https://www.gatsbyjs.org/docs/node-apis/): - `onNodeCreate` is now `onCreateNode` - `onUpsertPage` is now `onCreatePage` - `extendNodeType` is now `setFieldsOnGraphQLNodeType` -[gatsby-ssr.js APIs](https://www.gatsbyjs.com/docs/ssr-apis/): +[gatsby-ssr.js APIs](https://www.gatsbyjs.org/docs/ssr-apis/): - `modifyHeadComponents` and `modifyPostBodyComponents` were removed in favor of a new API - [`onRenderBody`](https://www.gatsbyjs.com/docs/ssr-apis/#onRenderBody). + [`onRenderBody`](https://www.gatsbyjs.org/docs/ssr-apis/#onRenderBody). - `replaceServerBodyRender` is now `replaceRenderer` ### Fixed @@ -7873,7 +7873,7 @@ export const pageQuery = graphql` ### Added -- Did the intitial build of the new gatsbyjs.com! It's in the `www` subdirectory +- Did the intitial build of the new gatsbyjs.org! It's in the `www` subdirectory on the 1.0 branch and is built on each push! That's my kind of integration testing :-) You can see the early version of the site at https://gatsbyjs.netlify.app/. PRs welcome!