Skip to content

Commit

Permalink
docs: convert console/shell/terminal into shell (gatsbyjs#17694)
Browse files Browse the repository at this point in the history
* replace console into shell

* replace sh into shell

* replace terminal into shell
  • Loading branch information
wardpeet authored and GatsbyJS Bot committed Sep 18, 2019
1 parent 16e9254 commit e6034f3
Show file tree
Hide file tree
Showing 42 changed files with 86 additions and 89 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ You can get a new Gatsby site up and running on your local dev environment in 5

Get your Gatsby blog set up in a single command:

```sh
```shell
# create a new Gatsby site using the default starter
gatsby new my-blazing-fast-site
```
Expand All @@ -115,7 +115,7 @@ You can get a new Gatsby site up and running on your local dev environment in 5

Next, move into your new site’s directory and start it up:

```sh
```shell
cd my-blazing-fast-site/
gatsby develop
```
Expand Down
4 changes: 2 additions & 2 deletions benchmarks/plugin-manifest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ Benchmarks the current production version of the plugin unless you use `gatsby-d

## To benchmark the current branch:

```sh
```shell
# In the root of the Gatsby repository
$ yarn run watch --scope=gatsby-plugin-manifest .
```

```sh
```shell
# In ./benchmarks/plugin-manifest
# You'll need 'gatsby-dev' installed and configured globally.
$ gatsby-dev --packages gatsby-plugin-manifest
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Gatsby uses [GraphQL](https://graphql.org/learn/) to share data across pages. Yo

## Gatsby project folder structure

```sh
```shell
├── LICENSE
├── README.md
├── gatsby-config.js
Expand Down Expand Up @@ -74,7 +74,7 @@ Let's assume you have the following static routes in your `create-react-app` pro

Gatsby will create these routes automatically based on files you create in your `pages` folder. The good news is you've already created the React components so it's a matter of copying them to the right place. The exception is the home page which should be named `index.js`.  You will end up with something like this:

```sh
```shell
├── LICENSE
├── README.md
├── gatsby-config.js
Expand Down Expand Up @@ -188,7 +188,7 @@ Since you already have the `BlogPost` component from your React project move it

Your Gatsby project will look like this:

```sh
```shell
├── LICENSE
├── README.md
├── gatsby-config.js
Expand Down
10 changes: 5 additions & 5 deletions docs/blog/2018-08-24-gatsby-aws-hosting/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,19 @@ Using the Amplify console, you can now easily deploy your application to AWS wit

First, we'll want to create a new Gatsby project. If you don't already have Gatsby installed, install it:

```sh
```shell
npm install --global gatsby-cli
```

Next, we'll create a new Gatsby site:

```sh
```shell
gatsby new my-gatsby-site
```

Finally, change into the new site directory:

```sh
```shell
cd my-gatsby-site
```

Expand All @@ -41,7 +41,7 @@ Now that we have our Gatsby site up & running, let's add hosting & make the site

To do so, create a new GitHub repo & push the project to the repo.

```sh
```shell
git init

git remote add origin [email protected]:<username>/<projectname>.git
Expand Down Expand Up @@ -103,7 +103,7 @@ with this:

Save the file & push the changes to your master branch:

```sh
```shell
git add .

git commit -m 'updated heading'
Expand Down
10 changes: 5 additions & 5 deletions docs/blog/2018-11-03-building-an-accessible-lightbox/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ In this tutorial you're going to cover the steps to creating a simple, custom, a

If you don't have Gatsby installed, open up your terminal and type in:

```terminal
```shell
$ npm install --global gatsby-cli
```

Then, still in your Terminal, head over to a folder you'd want to get started in and type in:

```terminal
```shell
$ gatsby new GatsbyLightbox https://github.com/gatsbyjs/gatsby-starter-default
```

Once it's done scaffolding the starter application, type in:

```terminal
```shell
$ cd GatsbyLightbox
$ yarn develop
```
Expand Down Expand Up @@ -127,7 +127,7 @@ By now, you should have all the images displaying on the home page and doing a f

For styling, you're going to be using [styled-components](https://www.styled-components.com/). To get it configured with Gatsby, run the following inside your terminal in your application:

```terminal
```shell
$ yarn add gatsby-plugin-styled-components styled-components babel-plugin-styled-components
```

Expand Down Expand Up @@ -192,7 +192,7 @@ For the sake of accessibility, you'll be using [Dialog](https://ui.reach.tech/di

Go ahead and install all the dependencies:

```terminal
```shell
$ yarn add @reach/dialog
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Tidy up your _package.json_ file and create workspaces which includes the projec

Next, you want to create your _site_ directory and your _packages_ directory within your _gatsby-theme_ project directory. Make sure the names that you choose for your directories are the same as what you put in your workspaces. You will also want to go into your packages directory and make another directory with the name of your theme. For the purpose of this tutorial, we will call it _theme_. Then you will want to `yarn init` the _theme_ directory and the _site_ directory.

```sh
```shell
mkdir site
mkdir packages
cd packages
Expand Down Expand Up @@ -167,7 +167,7 @@ You will need to add `gatsby` CLI scripts and specify your newly created `theme`

Now, you can make sure _site_ is linked to _theme_.

```sh
```shell
yarn
yarn workspaces info
```
Expand All @@ -193,7 +193,7 @@ Your workspace info should look similar to this:

Now that we've set up the site's _package.json_ we can run the workspace:

```sh
```shell
yarn workspace site develop
```

Expand All @@ -208,7 +208,7 @@ Your website content goes in _index.mdx_.

Now, rerun the development server and see your new content:

```sh
```shell
yarn workspace site develop
```

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/using-an-online-dev-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ In this mode you see the list of file changes on the left and can navigate throu

If you want to run another example you can open a terminal or use an existing one and run the following commands:

```sh
```shell
yarn install
gatsby-dev --set-path-to-repo ../..
gatsby-dev
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/mdx/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ your site.

1. **Initialize the MDX starter** with the Gatsby CLI

```sh
```shell
gatsby new my-mdx-starter https://github.com/ChristopherBiscardi/gatsby-starter-mdx-basic
```

1. **Run the dev server** by changing directory to the scaffolded site and install dependencies

```sh
```shell
cd my-mdx-starter/
gatsby develop
```
Expand All @@ -35,7 +35,7 @@ can follow these steps for configuring the [gatsby-plugin-mdx](/packages/gatsby-

1. **Add `gatsby-plugin-mdx`** and MDX as dependencies

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

Expand Down
4 changes: 2 additions & 2 deletions e2e-tests/development-runtime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ _Have another more specific idea? You may want to check out our vibrant collecti

Use the Gatsby CLI to create a new site, specifying the default starter.

```sh
```shell
# create a new Gatsby site using the default starter
gatsby new my-default-starter
```
Expand All @@ -26,7 +26,7 @@ _Have another more specific idea? You may want to check out our vibrant collecti

Navigate into your new site’s directory and start it up.

```sh
```shell
cd my-default-starter/
gatsby develop
```
Expand Down
6 changes: 3 additions & 3 deletions e2e-tests/gatsby-image/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ For an overview of the project structure please refer to the [Gatsby documentati

Make sure that you have the Gatsby CLI program installed:

```sh
```shell
npm install --global gatsby-cli
```

And run from your CLI:

```sh
```shell
gatsby new gatsby-example-site
```

Then you can run it by:

```sh
```shell
cd gatsby-example-site
gatsby develop
```
Expand Down
6 changes: 3 additions & 3 deletions e2e-tests/path-prefix/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ For an overview of the project structure please refer to the [Gatsby documentati

Make sure that you have the Gatsby CLI program installed:

```sh
```shell
npm install --global gatsby-cli
```

And run from your CLI:

```sh
```shell
gatsby new gatsby-example-site
```

Then you can run it by:

```sh
```shell
cd gatsby-example-site
gatsby develop
```
Expand Down
6 changes: 3 additions & 3 deletions e2e-tests/production-runtime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ For an overview of the project structure please refer to the [Gatsby documentati

Make sure that you have the Gatsby CLI program installed:

```sh
```shell
npm install --global gatsby-cli
```

And run from your CLI:

```sh
```shell
gatsby new gatsby-example-site
```

Then you can run it by:

```sh
```shell
cd gatsby-example-site
gatsby develop
```
Expand Down
4 changes: 2 additions & 2 deletions examples/using-shopify/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ _Have another more specific idea? You may want to check out our vibrant collecti

Use the Gatsby CLI to create a new site, specifying the default starter.

```sh
```shell
# create a new Gatsby site using the default starter
gatsby new my-default-starter https://github.com/gatsbyjs/gatsby-starter-default
```
Expand All @@ -27,7 +27,7 @@ _Have another more specific idea? You may want to check out our vibrant collecti

Navigate into your new site’s directory and start it up.

```sh
```shell
cd my-default-starter/
gatsby develop
```
Expand Down
4 changes: 2 additions & 2 deletions examples/using-type-definitions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ _Have another more specific idea? You may want to check out our vibrant collecti

Use the Gatsby CLI to create a new site, specifying the default starter.

```sh
```shell
# create a new Gatsby site using the default starter
gatsby new my-default-starter https://github.com/gatsbyjs/gatsby-starter-default
```
Expand All @@ -27,7 +27,7 @@ _Have another more specific idea? You may want to check out our vibrant collecti

Navigate into your new site’s directory and start it up.

```sh
```shell
cd my-default-starter/
gatsby develop
```
Expand Down
8 changes: 4 additions & 4 deletions packages/gatsby-codemods/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Add a `graphql` import to modules that use the `graphql` tag function without an

See the [Gatsby v2 migration guide for details on when to use this](https://gatsbyjs.org/docs/migrating-from-v1-to-v2/#import-graphql-from-gatsby).

```sh
```shell
jscodeshift -t node_modules/gatsby-codemods/dist/transforms/global-graphql-calls.js <path>
```

Expand Down Expand Up @@ -74,7 +74,7 @@ Import `Link` from `gatsby` instead of `gatsby-link` and remove the `gatsby-link

See the [Gatsby v2 migration guide for details on when to use this](https://gatsbyjs.org/docs/migrating-from-v1-to-v2/#import-link-from-gatsby).

```sh
```shell
jscodeshift -t node_modules/gatsby-codemods/dist/transforms/import-link.js <path>
```

Expand All @@ -95,7 +95,7 @@ Change the deprecated `navigateTo` method from `gatsby-link` to `navigate` from

See the [Gatsby v2 migration guide for details on when to use this](https://gatsbyjs.org/docs/migrating-from-v1-to-v2/#change-navigateto-to-navigate).

```sh
```shell
jscodeshift -t node_modules/gatsby-codemods/dist/transforms/navigate-calls.js <path>
```

Expand All @@ -122,7 +122,7 @@ Note: Run this codemod only against files that use `boundActionCreators` instead

See the [Gatsby v2 migration guide for details on when to use this](https://gatsbyjs.org/docs/migrating-from-v1-to-v2/#rename-boundactioncreators-to-actions).

```sh
```shell
jscodeshift -t node_modules/gatsby-codemods/dist/transforms/rename-bound-action-creators.js <path-to-file>
```

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 @@ -4,7 +4,7 @@ A list of utilities used in multiple gatsby packages.

## Usage

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

Expand Down
Loading

0 comments on commit e6034f3

Please sign in to comment.