Skip to content

Commit

Permalink
chore(docs): Remove --save from READMEs (#27032)
Browse files Browse the repository at this point in the history
Co-authored-by: Lennart <[email protected]>
  • Loading branch information
yashints and LekoArts authored Oct 5, 2020
1 parent 52c69bd commit 8437b65
Show file tree
Hide file tree
Showing 99 changed files with 112 additions and 112 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ Themes (like plugins) will be published on npm. So soon, starting a new Gatsby
blog will be as simple as:

```shell
npm install --save gatsby-super-cool-theme
npm install gatsby-super-cool-theme
gatsby build --theme gatsby-super-cool-theme
```

Expand Down
2 changes: 1 addition & 1 deletion docs/blog/2017-07-19-creating-a-blog-with-gatsby/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ with the following command:
yarn add gatsby-plugin-catch-links gatsby-plugin-react-helmet
```

You will be using [yarn][yarn], but npm can just as easily be used with `npm i --save [deps]`.
You will be using [yarn][yarn], but npm can just as easily be used with `npm install [deps]`.

After installing each of these functional plugins, edit
`gatsby-config.js`, which Gatsby loads at build-time to implement the exposed
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ Let's fix that. We need to teach Gatsby how to query the file system. Luckily
this is so common it's been done for you. Install the file system source plugin:

```shell
npm i --save gatsby-source-filesystem
npm install gatsby-source-filesystem
```

Now modify `gatsby-config.js` to both use the plugin and tell it what directory
Expand Down Expand Up @@ -230,7 +230,7 @@ files this is all you will need. But if you want to render markdown files as
HTML you will need another plugin. Let's add that now:

```shell
npm i --save gatsby-transformer-remark
npm install gatsby-transformer-remark
```

As before, add it to the `plugins` field in `gatsby-config.js`:
Expand Down
2 changes: 1 addition & 1 deletion docs/blog/2017-10-17-building-i18n-with-gatsby/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ implementation in other projects.

To get started, you'll need to install a few packages:

`npm i -S i18next i18next-xhr-backend i18next-browser-languagedetector react-i18next`
`npm install i18next i18next-xhr-backend i18next-browser-languagedetector react-i18next`

## Setting up

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,13 @@ In our case, we are using [Cosmic](https://cosmicjs.com). We need a source plugi
Install the source plugin with the following command:

```shell
npm install --save gatsby-source-cosmicjs
npm install gatsby-source-cosmicjs
```

We're going to use a couple other plugins later, so let's install them here:

```shell
npm install --save gatsby-plugin-offline gatsby-source-filesystem
npm install gatsby-plugin-offline gatsby-source-filesystem
```

These plugins need some configuration, so let's replace the content of `gatsby-config.js` with:
Expand Down Expand Up @@ -424,7 +424,7 @@ Restart the Gatsby server, then visit the detail page by clicking on URLs displa

In addition to the code covered in this tutorial, we also implemented `src/components/bio.js` to display author information & `src/layouts/index.js` to [create a generic layout](/tutorial/part-three/#our-first-layout-component) for the blog.

The source code for this tutorial is available [on GitHub](https://github.com/cosmicjs/gatsby-blog-cosmicjs). To see it live, clone the repository, and run (`cd gatsby-blog-cosmicjs && npm i && npm run develop`) or check out the [demo on Netlify](https://gatsby-blog-cosmicjs.netlify.app/).
The source code for this tutorial is available [on GitHub](https://github.com/cosmicjs/gatsby-blog-cosmicjs). To see it live, clone the repository, and run (`cd gatsby-blog-cosmicjs && npm install && npm run develop`) or check out the [demo on Netlify](https://gatsby-blog-cosmicjs.netlify.app/).

The static website generated by Gatsby can easily be published on services like Netlify, S3/CloudFront, GitHub Pages, GitLab Pages, Heroku, etc.

Expand Down
4 changes: 2 additions & 2 deletions docs/blog/2018-1-18-strapi-and-gatsby/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ _Requirements: please make sure [Node 10](https://nodejs.org/en/download/) (or h
Install Strapi using npm:

```shell
npm i strapi@alpha -g
npm install strapi@alpha -g
```

_Note: Strapi v3 is still an alpha version, but it will be fine for this tutorial._
Expand Down Expand Up @@ -256,7 +256,7 @@ In this example, we are using Strapi. Obviously, we are going to need a source p
Let's install it:

```shell
npm install --save gatsby-source-strapi
npm install gatsby-source-strapi
```

This plugin needs to be configured. Replace the content of `gatsby-config.js` with:
Expand Down
4 changes: 2 additions & 2 deletions docs/blog/2018-10-26-export-a-drupal-site-to-gatsby/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ To do this yourself, you'll build a simple blog using the excellent [gatsby-star
```shell
gatsby new gatsby-blog https://github.com/gatsbyjs/gatsby-starter-blog
git init # so you can keep track of the changes
npm i # to install regular gastby requirements
npm i --save-dev better-sqlite3 # to add an sqlite javascript client
npm install # to install regular gastby requirements
npm install --save-dev better-sqlite3 # to add an sqlite javascript client
```

The useful commands on a sqlite3 command line to explore are `.tables` to see all tables :) and `.schema table_name` to see information about a specific table. Oh! and `.help` to know more.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Kentico Cloud also makes it easy for editors to understand the hierarchical stru
For us developers, the headless CMS tools are very important. Apart from great technical documentation and many SDKs (including [JavaScript](http://bit.ly/2Gsq0Tb)), Kentico Cloud has a [source plugin for Gatsby](http://bit.ly/2S8ZzTO). If you decide to build a static site like I did, it's just another package that you install via npm.

```shell
npm install --save gatsby-source-kentico-cloud
npm install gatsby-source-kentico-cloud
```

which updates packages.json
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The Gatsby source plugin for Sanity comes with the ability to easily overlay dra
Add the source plugin to your Gatsby project:

```shell
npm install --save gatsby-source-sanity
npm install gatsby-source-sanity
```

The source plugin gives you a comprehensive GraphQL API in Gatsby for your structured content from Sanity. We strongly recommend using the [GraphiQL explorer](/docs/running-queries-with-graphiql/) to test queries and familiarize yourself with the schema documentation. It's super useful!
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Two weeks ago, we announced our plans for a [new schema customization API](/blog
First, install the latest and greatest version of `gatsby`, like so:

```shell
npm install gatsby --save
npm install gatsby
```

Next, continue reading below to see if any of the great, new features we've enabled scratch a particular itch. We feel very confident they will 💜
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ If you've been thinking about moving your blog from WordPress to a static site b
- I used Prettier on all the Markdown files to try to make them consistent. Here is a little snippet I used to run Prettier on all the posts:

```shell
npm i -g prettier # install prettier globally
npm install -g prettier # install prettier globally
cd content/posts # move to the directory that contains all your posts
prettier
--print-width 100
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ gatsby new my-blog-starter https://github.com/gatsbyjs/gatsby-starter-blog
Install [gatsby-plugin-mdx](/packages/gatsby-plugin-mdx/), the official plugin for using MDX with Gatsby. Also install `gatsby-plugin-feed-mdx` for our RSS feeds. Finally, install `@mdx-js/mdx` and `@mdx-js/react`.

```shell
npm install --save gatsby-plugin-mdx gatsby-plugin-feed-mdx @mdx-js/mdx @mdx-js/react
npm install gatsby-plugin-mdx gatsby-plugin-feed-mdx @mdx-js/mdx @mdx-js/react
```

### Step 2
Expand Down Expand Up @@ -103,7 +103,7 @@ Then, replace `gatsby-plugin-feed` with `gatsby-plugin-feed-mdx`. This will allo
Now, since we're no longer using `gatsby-transformer-remark` and `gatsby-plugin-feed`, you can uninstall them.

```shell
npm uninstall --save gatsby-transformer-remark gatsby-plugin-feed
npm uninstall gatsby-transformer-remark gatsby-plugin-feed
```

### Step 3
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Try out recipes today! Install the latest version of `gatsby-cli` and gatsby to

```shell
npm install -g gatsby-cli@latest
npm i gatsby@latest
npm install gatsby@latest
```

To stay current with future developments, follow the [Gatsby Recipes umbrella issue](https://github.com/gatsbyjs/gatsby/issues/22991).
2 changes: 1 addition & 1 deletion docs/docs/deploying-to-cloudflare-workers.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This guide will get you started in a few steps:
Workers Sites requires [wrangler](https://developers.cloudflare.com/workers/tooling/wrangler/). The more straight forward way to install wrangler is with [npm](https://www.npmjs.com/), run the following command:

```shell
npm i -g @cloudflare/wrangler
npm install -g @cloudflare/wrangler
```

2. Initialize the Project
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/deploying-to-s3-cloudfront.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Now that your Gatsby site is up and running and AWS access is sorted out, you'll
First, install the Gatsby S3 plugin:

```shell
npm i gatsby-plugin-s3
npm install gatsby-plugin-s3
```

Add it to your `gatsby-config.js`: (don't forget to change the bucket name)
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/maintaining-a-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ There are a couple of useful tools that can help with keeping dependencies up to
1. Install the tool

```shell
npm i -g npm-check-updates
npm install -g npm-check-updates
```

2. Run the command to update dependencies
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/migrating-from-v1-to-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ You need to update your `package.json` to use the latest version of Gatsby.
Or run

```shell
npm i gatsby@latest
npm install gatsby@latest
```

### Update Gatsby related packages
Expand All @@ -105,7 +105,7 @@ npm outdated
And compare "Wanted" and "Latest" versions and update `package.json` file manually or run

```shell
npm i gatsby-plugin-google-analytics@latest gatsby-plugin-netlify@latest gatsby-plugin-sass@latest
npm install gatsby-plugin-google-analytics@latest gatsby-plugin-netlify@latest gatsby-plugin-sass@latest
```

**NOTE**: The above command is only an example - adjust packages to ones you are using.
Expand All @@ -115,15 +115,15 @@ npm i gatsby-plugin-google-analytics@latest gatsby-plugin-netlify@latest gatsby-
In v1, the `react` and `react-dom` packages were a part of the `gatsby` package. They are now `peerDependencies` in v2, so you need to install them into your project.

```shell
npm i react react-dom
npm install react react-dom
```

### Install plugins' peer dependencies

Some plugins had dependencies that were also made `peerDependencies`. For example, if you use [`gatsby-plugin-typography`](/packages/gatsby-plugin-typography/), you now need to install:

```shell
npm i typography react-typography
npm install typography react-typography
```

You should search for the plugins that you use in the [plugin library](/plugins). Then, check their installation instructions for extra packages that may need installation.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/recipes/deploying-your-site.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ Use [`wrangler`](https://developers.cloudflare.com/workers/tooling/wrangler/) to
- An account on [Cloudflare](https://dash.cloudflare.com/sign-up)
- A [Workers Unlimited plan](https://developers.cloudflare.com/workers/about/pricing/) for \$5/month to enable the KV store, which is required to serve the Gatsby files.
- A [Gatsby site](/docs/quick-start) set up with Gatsby's CLI
- [wrangler](https://developers.cloudflare.com/workers/tooling/wrangler/install/) installed globally (`npm i -g @cloudflare/wrangler`)
- [wrangler](https://developers.cloudflare.com/workers/tooling/wrangler/install/) installed globally (`npm install -g @cloudflare/wrangler`)

### Directions

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/prismic-source-graphql-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ cd gatsby-prismic-blog
Now, you will have to install missing packages. This command includes the Gatsby Prismic source plugin, and the Prismic kits for facilitating processes in React:

```shell
npm i gatsby-source-prismic-graphql prismic-javascript prismic-reactjs
npm install gatsby-source-prismic-graphql prismic-javascript prismic-reactjs
```

If you want to focus on learning how to fetch and render data from a Prismic repository, it's safe to just use the sample repository `gatsby-blog-scratch` but you should create your own so you can modify the content and test out previews. Otherwise, you can follow [this article](https://prismic.io/docs/reactjs/getting-started/create-repo-minimalist-blog) to create your own Prismic repository. You will want to write several blog posts to have some nice content to show off.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ In order to display this component within a Markdown file, you'll need to add a
yarn add rehype-react

# If you use npm
npm install --save rehype-react
npm install rehype-react
```

2. Import `rehype-react` and whichever components you wish to use
Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby-core-utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A list of utilities used in multiple gatsby packages.
## Usage

```shell
npm install --save gatsby-core-utils
npm install gatsby-core-utils
```

### createContentDigest
Expand Down
4 changes: 2 additions & 2 deletions packages/gatsby-image/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,12 @@ effect as well as lazy loading of images further down the screen.

## Install

`npm install --save gatsby-image`
`npm install gatsby-image`

Depending on the gatsby starter you used, you may need to include [gatsby-transformer-sharp](/packages/gatsby-transformer-sharp/) and [gatsby-plugin-sharp](/packages/gatsby-plugin-sharp/) as well, and make sure they are installed and included in your gatsby-config.

```shell
npm install --save gatsby-transformer-sharp gatsby-plugin-sharp
npm install gatsby-transformer-sharp gatsby-plugin-sharp
```

Then in your `gatsby-config.js`:
Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby-plugin-canonical-urls/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ paths to the same page.

## Install

`npm install --save gatsby-plugin-canonical-urls`
`npm install gatsby-plugin-canonical-urls`

## How to use

Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby-plugin-catch-links/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Example use cases:
## Installation

```shell
npm install --save gatsby-plugin-catch-links
npm install gatsby-plugin-catch-links
```

## How to use
Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby-plugin-coffeescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Provides drop-in support for CoffeeScript and CJSX.

## Install

`npm install --save gatsby-plugin-coffeescript`
`npm install gatsby-plugin-coffeescript`

## How to use

Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby-plugin-create-client-paths/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ For more information refer to [client-only routes & user authentication](https:/
Install:

```shell
npm install --save gatsby-plugin-create-client-paths
npm install gatsby-plugin-create-client-paths
```

Then configure via `gatsby-config.js`:
Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby-plugin-cxs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A [Gatsby](https://github.com/gatsbyjs/gatsby) plugin for

## Install

`npm install --save gatsby-plugin-cxs cxs`
`npm install gatsby-plugin-cxs cxs`

## How to use

Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby-plugin-emotion/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ guide](https://emotion.sh/docs/migrating-to-emotion-10#incremental-migration) fo
## Install

```shell
npm install --save gatsby-plugin-emotion @emotion/core @emotion/styled
npm install gatsby-plugin-emotion @emotion/core @emotion/styled
```

## How to use
Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby-plugin-facebook-analytics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This loads the Facebook JavaScript SDK which means that [Social Plugins](https:/

## Install

`npm install --save gatsby-plugin-facebook-analytics`
`npm install gatsby-plugin-facebook-analytics`

## How to use

Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby-plugin-feed/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Create an RSS feed (or multiple feeds) for your Gatsby site.

## Install

`npm install --save gatsby-plugin-feed`
`npm install gatsby-plugin-feed`

## How to Use

Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby-plugin-fullstory/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Fullstory is an analytics service for recording customer visits. This plugin add

## Install

`npm install --save gatsby-plugin-fullstory`
`npm install gatsby-plugin-fullstory`

## How to use

Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby-plugin-glamor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ rendering and start writing React components that carry their styles with them.

## Install

`npm install --save gatsby-plugin-glamor glamor`
`npm install gatsby-plugin-glamor glamor`

## How to use

Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby-plugin-google-analytics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Easily add Google Analytics to your Gatsby site.

## Install

`npm install --save gatsby-plugin-google-analytics`
`npm install gatsby-plugin-google-analytics`

## How to use

Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby-plugin-google-gtag/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ NOTE: This plugin only works in production mode! To test your Global Site Tag is

## Install

`npm install --save gatsby-plugin-google-gtag`
`npm install gatsby-plugin-google-gtag`

## How to use

Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby-plugin-google-tagmanager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Easily add Google Tagmanager to your Gatsby site.

## Install

`npm install --save gatsby-plugin-google-tagmanager`
`npm install gatsby-plugin-google-tagmanager`

## How to use

Expand Down
Loading

0 comments on commit 8437b65

Please sign in to comment.