Skip to content

Add Gatsby installation to startup docs #904

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jan 5, 2021
Merged

Add Gatsby installation to startup docs #904

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d74f8df
add gatsby cli install docs
Nov 10, 2020
37c16eb
Update CONTRIBUTING.md
Nov 10, 2020
05e660e
Update CONTRIBUTING.md
Dec 4, 2020
ad64aca
Update CONTRIBUTING.md
Dec 4, 2020
472ed24
Update CONTRIBUTING.md
Dec 4, 2020
7f4333e
Merge branch 'main' into startup-docs
Jan 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,13 @@ A common question asked about Primer Components is how to know what should be ad

We primarily use our documentation site as a workspace to develop new components or make changes to existing components (stay tuned for a better development environment coming soon!).

To get the documentation site running locally run the following in your terminal:
Before running the documentation site locally you'll need to install packages and make sure you've got the [Gatsby cli](https://www.gatsbyjs.com/docs/gatsby-cli/) installed on your machine:

```sh
yarn && yarn global add gatsby-cli
```

Then run the following to start up the site:

```sh
yarn start
Expand Down