From 810174de3762d362ecb35031967d3dda309ea477 Mon Sep 17 00:00:00 2001 From: jokokoloko Date: Wed, 7 Aug 2019 15:02:46 -0700 Subject: [PATCH] =?UTF-8?q?fix(docs):=20add=20note=20for=20exception=20whe?= =?UTF-8?q?n=20using=20gatsby-source-con=E2=80=A6=20(#15926)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * fix(docs): add note for exception when using gatsby-source-contentful Using gatsby-transformer-sharp along with gatsby-source-contentful, while using the default behavior of the source plugin to link to Contentful's CDN instead of downloading the assets to the to the local filesystem, results in a warning during compiling. * Update packages/gatsby-transformer-sharp/README.md Co-Authored-By: Kitten King <53072918+kittenking@users.noreply.github.com> * Update packages/gatsby-transformer-sharp/README.md * Update packages/gatsby-transformer-sharp/README.md * fix: prettier --- packages/gatsby-transformer-sharp/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/gatsby-transformer-sharp/README.md b/packages/gatsby-transformer-sharp/README.md index 05b1c89629f69..9561ec6651e52 100644 --- a/packages/gatsby-transformer-sharp/README.md +++ b/packages/gatsby-transformer-sharp/README.md @@ -21,7 +21,9 @@ 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`](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-source-filesystem) or source plugins for (headless) CMSs like [`gatsby-source-wordpress`](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-source-wordpress). +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`](/packages/gatsby-source-filesystem) or source plugins for (headless) CMSs like [`gatsby-source-wordpress`](/packages/gatsby-source-wordpress). + +**Note**: An exception to this is when using [`gatsby-source-contentful`](/packages/gatsby-source-contentful/), as the source plugin and the assets are not [downloaded to the local filesystem](https://www.gatsbyjs.org/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`. ## Parsing algorithm