Skip to content

docs: Suggestion: unify npm / remove --save from npm install #22444

@muescha

Description

@muescha

Summary

Unify npm install commands in docs and all README

Suggested changes:

  • 1) remove --save from npm install
  • 2) replace npm i with npm install
  • 3) put --save-dev as first param after install
    (npm install dep1 dep2 --save-dev -> npm install --save-dev dep1 dep2)
  • 4) put commands in code blocks for better copy paste

Motivation

  • --save is not anymore needed - see cpmments:

  • i -> install more easy to know for new users what i means

  • --save-dev more visible option

  • Putting the install snippet in its own code block makes it easier for people to copy the snippet. I believe this is also consistent with other doc pages. (Put install in its own code block #22359)

Steps to resolve this issue

Draft the doc

Open a pull request

  • Open a pull request with your work including the words "closes #[this issue's number]" in the pull request description

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueIssue that doesn't require previous experience with Gatsbyhelp wantedIssue with a clear description that the community can help with.type: documentationAn issue or pull request for improving or updating Gatsby's documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions