Skip to content
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

Docs - added prerequisites #4127

Closed
wants to merge 1 commit into from
Closed

Docs - added prerequisites #4127

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 8 additions & 0 deletions docs/docs/gatsby-starters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ This downloads the files and initializes the site by running `npm install`
If you don't specify a custom starter, your site will be created from the
[default starter](https://github.com/gatsbyjs/gatsby-starter-default).

## Prerequisites
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great! Definitely is needed.

I don't think this is the right place for this however — we should have a generic setup Linux for Gatsby pages similar to what we have for Windows https://www.gatsbyjs.org/docs/gatsby-on-windows/

Then this section could link out to those more detailed pages. Probably this section should also hint at the prerequisites e.g. native compilation + Python so people who are running into problems get a hint that they should really go check out the other page in detail for help.

How's that sound?

Starters may use npm plugins that require [native node extensions](https://github.com/nodejs/node-gyp). For those to build, you will need to install `build-essential` from your package source.

For example, on Debian/Ubuntu:

`sudo apt-get install build-essential`

## Available Starters
There are several starters that have been created. Create a PR to include yours!

Official:
Expand Down