Skip to content

Commit 12eb412

Browse files
authored
chore(docs): realease notes - code fences, code language (#28936)
1 parent b2729dd commit 12eb412

File tree

5 files changed

+30
-30
lines changed

5 files changed

+30
-30
lines changed

docs/docs/reference/release-notes/v2.26/index.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ Key highlights of this release:
1313
- [New Image Plugin (beta)](#gatsby-plugin-image010-beta) - access static images without GraphQL, high Lighthouse scores again
1414
- [File System Route API](#file-system-route-api) - create routes from your data using filename conventions
1515
- [New Release Process](#new-release-process) - more stability and clarity around Gatsby releases
16-
- [gatsby-source-contentful v4.0](#gatsby-source-contentful400) - new RichText implementation, performance improvements
16+
- [`gatsby-source-contentful` v4.0](#gatsby-source-contentful400) - new RichText implementation, performance improvements
1717

1818
Other notable changes:
1919

20-
- [gatsby-plugin-mdx](#gatsby-plugin-mdx140) - performance improvements
20+
- [`gatsby-plugin-mdx`](#gatsby-plugin-mdx140) - performance improvements
2121
- [Enable compression in the dev server](#enable-compression-in-the-dev-server) - speeds up remote previews
2222

2323
Sneak peek to next releases:
@@ -53,19 +53,19 @@ and related PR [#27424](https://github.com/gatsbyjs/gatsby/pull/27424).
5353
### Enable compression in the dev server
5454

5555
This lowers the amount of data transferred for one site especially in remote situations.
56-
Most of that drop was from the commons.js bundle.
56+
Most of that drop was from the `commons.js` bundle.
5757

5858
See PR [#27948](https://github.com/gatsbyjs/gatsby/pull/27948) for details.
5959

60-
60+
## `[email protected]` (beta)
6161

6262
[New image plugin](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-image) to replace `gatsby-image`, which greatly improves performance (Lighthouse 💯 again) and adds easy static images (no GraphQL). Part of it is also a new, simpler API for `gatsby-transformer-sharp`.
6363

64-
### StaticImage
64+
### `StaticImage`
6565

6666
This component is a new, simpler way to use Gatsby's image processing for static images without needing to write GraphQL queries:
6767

68-
```js
68+
```jsx
6969
import React from "react"
7070
import { StaticImage } from "gatsby-plugin-image"
7171

@@ -74,7 +74,7 @@ export const Dino = () => (
7474
)
7575
```
7676

77-
### GatsbyImage
77+
### `GatsbyImage`
7878

7979
This is a complete rewrite of the Gatsby Image component, using native lazy loading whenever possible.
8080
In our tests it allows sites whose Lighthouse scores dropped in recent updates to get back to 100s across the board.
@@ -108,7 +108,7 @@ export function Plant({ data }) {
108108
- [Details, Migration guide and discussion](https://github.com/gatsbyjs/gatsby/discussions/27950)
109109
- [Documentation](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-image)
110110

111-
111+
112112

113113
### New Rich Text Implementation
114114

@@ -127,7 +127,7 @@ it manually in your site config to see performance improvements.
127127
Due to technical limitations, the response payload size is still bound by a hard chunk download
128128
size, so it is possible you may need to use a lower value for your particular site.
129129

130-
130+
131131

132132
There was a significant performance improvement by making a certain node fetching step lazy.
133133
This is especially noticeable at scale. See PR [#27937](https://github.com/gatsbyjs/gatsby/pull/27937) for details.
@@ -142,7 +142,7 @@ This would avoid having to wait for slower queries (like image processing) if yo
142142

143143
Try early alpha (and [let us know](https://github.com/gatsbyjs/gatsby/discussions/27620) if you have any issues with it):
144144

145-
```
145+
```shell
146146
npm install gatsby@qod
147147
```
148148

@@ -164,7 +164,7 @@ This experimental version of `gatsby-plugin-sharp` only does image processing wh
164164

165165
Try early alpha (and [let us know](https://github.com/gatsbyjs/gatsby/discussions/27603) if you have any issues with it):
166166

167-
```
167+
```shell
168168
npm install gatsby-plugin-sharp@lazy-images
169169
```
170170

docs/docs/reference/release-notes/v2.27/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ Welcome to `[email protected]` release (November 2020 #2).
1111

1212
Key highlights of this release:
1313

14-
- [create-gatsby](#create-gatsby) - new, interactive way to create a Gatsby site
14+
- [`create-gatsby`](#create-gatsby) - new, interactive way to create a Gatsby site
1515
- [Experimental: Queries on Demand](#experimental-queries-on-demand) - improves `gatsby develop` bootup time
1616
- [Experimental: Lazy page bundling](#experimental-lazy-page-bundling-in-development) - also improves `gatsby develop` bootup time
1717
- [Experimental: SSR in develop](#experimental-ssr-in-development) - catch SSR errors early
18-
- [[email protected]](#gatsby-plugin-mdx150) - new option for better performance
18+
- [`[email protected]`](#gatsby-plugin-mdx150) - new option for better performance
1919
- [Notable bugfixes](#notable-bugfixes)
2020

2121
Sneak peek to next releases:
@@ -29,7 +29,7 @@ Sneak peek to next releases:
2929

3030
[Full changelog](https://github.com/gatsbyjs/gatsby/compare/[email protected]@2.27.0)
3131

32-
## create-gatsby
32+
## `create-gatsby`
3333

3434
There is now a new, interactive way to create a Gatsby site. As long as you have Node.js installed you're ready to go.
3535

@@ -75,7 +75,7 @@ Try it out immediately by running `GATSBY_EXPERIMENTAL_DEV_SSR=true gatsby devel
7575

7676
### Experimental: Lazy page bundling in development
7777

78-
UPDATE: After a number of community members tested the change on their website, we decided it wasn't going to work outhttps://github.com/gatsbyjs/gatsby/discussions/28137#discussioncomment-138998
78+
UPDATE: After a number of community members tested the change on their website, we decided it wasn't going to work outhttps://github.com/gatsbyjs/gatsby/discussions/28137#discussioncomment-138998
7979

8080
An obstacle to Gatsby being a delightful experience for larger sites is JavaScript compilation can start to get annoyingly slow. For example, gatsbyjs.com takes over two minutes currently (with a cold cache) to compile and bundle the code for the many page components. Not acceptable!
8181

@@ -85,7 +85,7 @@ Now when you run `GATSBY_EXPERIMENT_DEVJS_LAZY=true gatsby develop`, webpack won
8585

8686
All sites should see some speedups but it's especially noticeable for larger sites like gatsbyjs.com which now starts webpack 81% faster than before! Please test it out and tell us how fast your dev server boots up over at the [umbrella issue](https://github.com/gatsbyjs/gatsby/discussions/28137) along with any bugs you might run across.
8787

88-
88+
8989

9090
Adds a `lessBabel` option to the plugin which allows you to use a fast path for scanning exports during sourcing. The savings are significant, especially at scale, but as the new scanner does not use Babel, if your site depends on Babel then you can't use this. Please give the option a try and report any problems unrelated to not running Babel so we can improve the support.
9191

@@ -106,7 +106,7 @@ This experimental version of `gatsby-plugin-sharp` only does image processing wh
106106

107107
Try early alpha (and [let us know](https://github.com/gatsbyjs/gatsby/discussions/27603) if you have any issues with it):
108108

109-
```
109+
```shell
110110
npm install gatsby-plugin-sharp@lazy-images
111111
```
112112

docs/docs/reference/release-notes/v2.28/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ Welcome to `[email protected]` release (December 2020 #1).
1212
Key highlights of this release:
1313

1414
- [New `gatsby new`](#new-gatsby-new) - new, interactive way to create a Gatsby site
15-
- [Feature flags in gatsby-config](#feature-flags-in-gatsby-config) - set your feature toggles without environment variables
15+
- [Feature flags in `gatsby-config.js`](#feature-flags-in-gatsby-configjs) - set your feature toggles without environment variables
1616
- [Improved Fast Refresh integration](#improved-fast-refresh-integration) - better hot reloading
1717
- [Experimental: Lazy images in develop](#experimental-lazy-images-in-develop) - run image transformations only when they are needed by browser
1818

1919
Other notable changes:
2020

2121
- [Image plugin helpers](#image-plugin-helpers) - make it easier for plugin authors to support the new gatsby image plugin
2222
- [Experimental: New cache clearing behaviors](#experimental-new-cache-clearing-behaviors) - we're experimenting with ways to be smarter about clearing caches
23-
- [gatsby-plugin-emotion v5.0](#gatsby-plugin-emotion500) - now uses emotion v11
23+
- [`gatsby-plugin-emotion` v5.0](#gatsby-plugin-emotion500) - now uses emotion v11
2424
- [Removed experimental lazy page bundling](#removed-experimental-lazy-page-bundling)
2525
- [Notable bugfixes](#notable-bugfixes)
2626

@@ -39,7 +39,7 @@ if you have any [issues](https://github.com/gatsbyjs/gatsby/issues).
3939

4040
In previous release we added [interactive way of scaffolding new gatsby project](/docs/reference/release-notes/v2.27#create-gatsby) (with `npm init gatsby`). As of this release, `gatsby new` (without any addition arguments) will use the same flow.
4141

42-
## Feature flags in `gatsby-config`
42+
## Feature flags in `gatsby-config.js`
4343

4444
Gatsby traditionally used environment variables to use various modes or enable experimental features. This worked, but it was far from pleasant and had many issues, notably:
4545

@@ -66,7 +66,7 @@ Currently supported flags:
6666
- `QUERY_ON_DEMAND` - Only run queries when needed instead of running all queries upfront. Speeds starting the develop server.
6767
- `LAZY_IMAGES` - Don't process images during development until they're requested from the browser. Speeds starting the develop server (requires `gatsby-plugin-sharp@^2.10.0`). See [Experimental: Lazy images in develop](#experimental-lazy-images-in-develop) section for additional details.
6868
- `FAST_DEV` - Umbrella flag that enables `DEV_SSR`, `QUERY_ON_DEMAND` and `LAZY_IMAGES` features.
69-
- `FAST_REFRESH` - Use React Fast Refresh instead of the legacy react-hot-loader for instantaneous feedback in your development server. Recommended for versions of React >= 17.0.
69+
- `FAST_REFRESH` - Use React Fast Refresh instead of the legacy `react-hot-loader` for instantaneous feedback in your development server. Recommended for versions of React >= 17.0.
7070

7171
## Improved Fast Refresh integration
7272

@@ -138,7 +138,7 @@ module.exports = {
138138
}
139139
```
140140

141-
141+
142142

143143
The plugin is updated to the new major version of emotion: v11. Check out [this post](https://emotion.sh/docs/emotion-11) in emotion docs for updates.
144144

@@ -157,7 +157,7 @@ In `[email protected]` we added [Experimental: Lazy page bundling](/docs/reference/r
157157

158158
Plugin APIs in Gatsby run serially. Generally this what we want as most API calls are CPU/IO bound so things are fastest letting each plugin have the full undivided attention of your computer. But source plugins are often _network_ bound as they're hitting remote APIs and waiting for responses. We tried [changing the invocation of `sourceNodes` to parallel](https://github.com/gatsbyjs/gatsby/pull/28214) on a few sites with 4+ source plugins and saw a big speedup on sourcing (40%+) as they were no longer waiting on each other to start their API calls.
159159

160-
This is a very "Your mileage may vary" situation — not all sites will notice any difference and also not all source plugins are network bound (gatsby-source-filesystem reads from the local machine). We're looking at finding better heuristics so that all sites are as fast as possible at data sourcing but in the meantime, if you have sites with multiple source plugins, this could be a big help.
160+
This is a very "Your mileage may vary" situation — not all sites will notice any difference and also not all source plugins are network bound (`gatsby-source-filesystem` reads from the local machine). We're looking at finding better heuristics so that all sites are as fast as possible at data sourcing but in the meantime, if you have sites with multiple source plugins, this could be a big help.
161161

162162
You can try it today using `gatsby@next` version and adding a flag to your `gatsby-config.js`:
163163

docs/docs/reference/release-notes/v2.29/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Other notable changes:
2020

2121
- [Performance improvements](#performance-improvements)
2222
- [Slugify option for File System Route API](#slugify-option-for-file-system-route-api)
23-
- [gatsby-image codemod](#gatsby-image-codemod)
23+
- [`gatsby-image` codemod](#gatsby-image-codemod)
2424
- [Notable bugfixes](#notable-bugfixes)
2525

2626
**Bleeding Edge:** Want to try new features as soon as possible? Install `gatsby@next` and let us know
@@ -131,7 +131,7 @@ We were able to ship a bunch of performance improvements both to Gatsby itself a
131131

132132
The File System Route API uses [slugify](https://github.com/sindresorhus/slugify) to create slugs for the generated routes. You're now able to pass custom options to that instance, e.g. when you want to change the separator. The full details are listed in the [README](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-page-creator) of `gatsby-plugin-page-creator`.
133133

134-
## gatsby-image codemod
134+
## `gatsby-image` codemod
135135

136136
We introduced some API changes for working with images when we published the new `gatsby-plugin-image` in [v2.26](/docs/reference/release-notes/v2.26#gatsby-plugin-image010-beta). In order to make it easier to migrate your code to work with the new plugin, we've created a codemod. Follow the migration instructions in the [README](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-image#upgrading-from-the-gatsby-image2) in order to run the codemod against your project.
137137

docs/docs/reference/release-notes/v2.30/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Key highlights of this release:
1313

1414
- [Query on Demand and Lazy Images: Generally available](#query-on-demand-and-lazy-images-generally-available) - improves `gatsby develop` bootup time
1515
- [Server Side Rendering (SSR) in development](#server-side-rendering-ssr-in-development) — helps you find and fix many build errors in development. We're starting a partial release of this feature to 5% of users.
16-
- [gatsby-plugin-sass v3](#gatsby-plugin-sass300) - use the latest `sass-loader` and `Dart Sass` by default
16+
- [`gatsby-plugin-sass` v3](#gatsby-plugin-sass300) - use the latest `sass-loader` and `Dart Sass` by default
1717
- [Image transformations up to 30% faster](#gatsby-plugin-sharp2120)
1818

1919
And several impactful updates in the new [`gatsby-plugin-image`](#gatsby-plugin-image050-beta) (beta):
@@ -76,7 +76,7 @@ module.exports = {
7676
}
7777
```
7878

79-
79+
8080

8181
Now that [LibSass and Node Sass are deprecated](https://sass-lang.com/blog/libsass-is-deprecated), we've
8282
upgraded `sass-loader` to `10.1.0` and thus switched sass implementation to [Dart Sass](https://sass-lang.com/dart-sass).
@@ -92,7 +92,7 @@ See also:
9292
- https://github.com/gatsbyjs/gatsby/issues/27754
9393
- https://github.com/gatsbyjs/gatsby/pull/27991
9494

95-
95+
9696

9797
New approach to concurrency speeds up image transformations up to 30%.
9898

@@ -102,7 +102,7 @@ to each image serially.
102102

103103
Another major change is [lazy images in develop](#query-on-demand-and-lazy-images-generally-available).
104104

105-
105+
## `[email protected] (beta)`
106106

107107
### AVIF support
108108

@@ -154,7 +154,7 @@ GATSBY_EXPERIMENTAL_REMOTE_IMAGES=1 gatsby build
154154

155155
You can then pass absolute URLs to `StaticImage`:
156156

157-
```js
157+
```jsx
158158
<StaticImage src="https://placekitten.com/400/400" alt="Kittin" />
159159
```
160160

0 commit comments

Comments
 (0)