Skip to content

Commit e86f15a

Browse files
committed
1 parent d44b740 commit e86f15a

File tree

2 files changed

+190
-0
lines changed

2 files changed

+190
-0
lines changed
Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
---
2+
path: '/materials/gatsby'
3+
type: 'GitHub'
4+
img: './screenshot.png'
5+
material:
6+
title: 'gatsby'
7+
url: 'https://www.gatsbyjs.org'
8+
github_url: 'https://github.com/gatsbyjs/gatsby'
9+
subscribers_count: '685'
10+
stargazers_count: '31482'
11+
tags: ['blog','compiler','documentation-tool','gatsby','graphql','react','static-site-generator','web-app']
12+
subtitle: 'Build blazing fast, modern apps and websites with React'
13+
clone_url: 'https://github.com/gatsbyjs/gatsby.git'
14+
ssh_url: 'git@github.com:gatsbyjs/gatsby.git'
15+
pushed_at: '2019-02-13T18:51:54Z'
16+
updated_at: '2019-02-13T18:38:28Z'
17+
author:
18+
name: 'gatsbyjs'
19+
avatar: 'https://avatars1.githubusercontent.com/u/12551863?v=4'
20+
github_url: 'https://github.com/gatsbyjs'
21+
latestRelease:
22+
tag_name: 'v1.5.2'
23+
name: 'New MongoDB source plugin!'
24+
url: 'https://github.com/gatsbyjs/gatsby/releases/tag/v1.5.2'
25+
created_at: '2017-07-27T19:54:40Z'
26+
---
27+
<p align='center'>
28+
<a href='https://gatsbyjs.org'>
29+
<img alt='Gatsby' src='https://www.gatsbyjs.org/monogram.svg' width='60' />
30+
</a>
31+
</p>
32+
<h1 align='center'>
33+
Gatsby v2
34+
</h1>
35+
36+
<h3 align='center'>
37+
⚛️ 📄 :rocket:
38+
</h3>
39+
<p align='center'>
40+
<strong>Blazing fast modern site generator for React</strong><br>
41+
Go beyond static sites: build blogs, e-commerce sites, full-blown apps, and more with Gatsby.
42+
</p>
43+
<p align='center'>
44+
<a href='https://github.com/gatsbyjs/gatsby/blob/master/LICENSE'>
45+
<img src='https://img.shields.io/badge/license-MIT-blue.svg' alt='Gatsby is released under the MIT license.' />
46+
</a>
47+
<a href='https://circleci.com/gh/gatsbyjs/gatsby'>
48+
<img src='https://circleci.com/gh/gatsbyjs/gatsby.svg?style=shield' alt='Current CircleCI build status.' />
49+
</a>
50+
<a href='https://www.npmjs.org/package/gatsby'>
51+
<img src='https://img.shields.io/npm/v/gatsby.svg' alt='Current npm package version.' />
52+
</a>
53+
<a href='https://npmcharts.com/compare/gatsby?minimal=true'>
54+
<img src='https://img.shields.io/npm/dm/gatsby.svg' alt='Downloads per month on npm.' />
55+
</a>
56+
<a href='https://npmcharts.com/compare/gatsby?minimal=true'>
57+
<img src='https://img.shields.io/npm/dt/gatsby.svg' alt='Total downloads on npm.' />
58+
</a>
59+
<a href='https://gatsbyjs.org/docs/how-to-contribute'>
60+
<img src='https://img.shields.io/badge/PRs-welcome-brightgreen.svg' alt='PRs welcome!' />
61+
</a>
62+
<a href='https://twitter.com/intent/follow?screen_name=gatsbyjs'>
63+
<img src='https://img.shields.io/twitter/follow/gatsbyjs.svg?label=Follow%20@gatsbyjs' alt='Follow @gatsbyjs' />
64+
</a>
65+
</p>
66+
67+
<h3 align='center'>
68+
<a href='https://gatsbyjs.org/docs/'>Quickstart</a>
69+
<span> · </span>
70+
<a href='https://gatsbyjs.org/tutorial/'>Tutorial</a>
71+
<span> · </span>
72+
<a href='https://gatsbyjs.org/plugins/'>Plugins</a>
73+
<span> · </span>
74+
<a href='https://gatsbyjs.org/starters/'>Starters</a>
75+
<span> · </span>
76+
<a href='https://gatsbyjs.org/showcase/'>Showcase</a>
77+
<span> · </span>
78+
<a href='https://gatsbyjs.org/docs/how-to-contribute/'>Contribute</a>
79+
<span> · </span>
80+
Support: <a href='https://spectrum.chat/gatsby-js'>Spectrum</a>
81+
<span> & </span>
82+
<a href='https://gatsby.app/discord'>Discord</a>
83+
</h3>
84+
85+
Gatsby is a modern framework for blazing fast websites.
86+
87+
- **Go Beyond Static Websites.** Get all the benefits of static websites with none of the
88+
limitations. Gatsby sites are fully functional React apps so you can create high-quality,
89+
dynamic web apps, from blogs to e-commerce sites to user dashboards.
90+
91+
- **Use a Modern Stack for Every Site.** No matter where the data comes from, Gatsby sites are
92+
built using React and GraphQL. Build a uniform workflow for you and your team, regardless of
93+
whether the data is coming from the same backend.
94+
95+
- **Load Data From Anywhere.** Gatsby pulls in data from any data source, whether it’s Markdown
96+
files, a headless CMS like Contentful or WordPress, or a REST or GraphQL API. Use source plugins
97+
to load your data, then develop using Gatsby’s uniform GraphQL interface.
98+
99+
- **Performance Is Baked In.** Ace your performance audits by default. Gatsby automates code
100+
splitting, image optimization, inlining critical styles, lazy-loading, and prefetching resources,
101+
and more to ensure your site is fast — no manual tuning required.
102+
103+
- **Host at Scale for Pennies.** Gatsby sites don’t require servers so you can host your entire
104+
site on a CDN for a fraction of the cost of a server-rendered site. Many Gatsby sites can be
105+
hosted entirely free on services like GitHub Pages and Netlify.
106+
107+
[**Learn how to use Gatsby for your next project.**](https://gatsbyjs.org/docs/)
108+
109+
## What’s In This Document
110+
111+
- [Get Up and Running in 5 Minutes](#-get-up-and-running-in-5-minutes)
112+
- [Learning Gatsby](#-learning-gatsby)
113+
- [Migration Guides](#-migration-guides)
114+
- [How to Contribute](#-how-to-contribute)
115+
- [License](#memo-license)
116+
- [Thanks to Our Contributors and Sponsors](#-thanks-to-our-contributors-and-sponsors)
117+
118+
## 🚀 Get Up and Running in 5 Minutes
119+
120+
You can get a new Gatsby site up and running on your local dev environment in 5 minutes with these three steps:
121+
122+
1. **Create a Gatsby site from a Gatsby starter.**
123+
124+
Get your Gatsby blog set up in a single command:
125+
126+
```sh
127+
# create a new Gatsby site using the default starter
128+
npx gatsby new my-blazing-fast-site
129+
```
130+
131+
2. **Start the site in `develop` mode.**
132+
133+
Next, move into your new site’s directory and start it up:
134+
135+
```sh
136+
cd my-blazing-fast-site/
137+
gatsby develop
138+
```
139+
140+
3. **Open the source code and start editing!**
141+
142+
Your site is now running at `http://localhost:8000`. Open the `my-blazing-fast-site` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes, and the browser will update in real time!
143+
144+
At this point, you’ve got a fully functional Gatsby website. For additional information on how you can customize your Gatsby site, see our [plugins](https://gatsbyjs.org/plugins/) and [the official tutorial](https://gatsbyjs.org/tutorial/).
145+
146+
## 🎓 Learning Gatsby
147+
148+
Full documentation for Gatsby lives [on the website](https://gatsbyjs.org/).
149+
150+
- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.
151+
152+
- **To dive straight into code samples head [to our documentation](https://gatsbyjs.org/docs/).** In particular, check out the “<i>Guides</i>”, “<i>API Reference</i>”, and “<i>Advanced Tutorials</i>” sections in the sidebar.
153+
154+
We welcome suggestions for improving our docs. See the [“how to contribute”](https://gatsbyjs.org/docs/how-to-contribute/) documentation for more details.
155+
156+
**Start Learning Gatsby: [Follow the Tutorial](https://gatsbyjs.org/tutorial/) · [Read the Docs](https://gatsbyjs.org/docs/)**
157+
158+
## 💼 Migration Guides
159+
160+
Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v2 to your site without starting from scratch!
161+
162+
- [Migrate a Gatsby site from v1 to v2](https://gatsbyjs.org/docs/migrating-from-v1-to-v2/)
163+
- Still on v0? Start here: [Migrate a Gatsby site from v0 to v1](https://gatsbyjs.org/docs/migrating-from-v0-to-v1/)
164+
165+
## 🤝 How to Contribute
166+
167+
Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Gatsby community! :muscle::purple_heart:
168+
169+
Check out our [**Contributing Guide**](https://gatsbyjs.org/docs/how-to-contribute/) for ideas on contributing and setup steps for getting our repositories up and running on your local machine.
170+
171+
### Code of Conduct
172+
173+
Gatsby is dedicated to building a welcoming, diverse, safe community. We expect everyone participating in the Gatsby community to abide by our [**Code of Conduct**](https://gatsbyjs.org/docs/code-of-conduct/). Please read it. Please follow it. In the Gatsby community, we work hard to build each other up and create amazing things together. 💪💜
174+
175+
### A note on how this repository is organized
176+
177+
This repository is a [monorepo](https://trunkbaseddevelopment.com/monorepos/) managed using [Lerna](https://github.com/lerna/lerna). This means there are [multiple packages](/packages) managed in this codebase, even though we publish them to NPM as separate packages.
178+
179+
### Contributing to Gatsby v1
180+
181+
We are currently only accepting bug fixes for Gatsby v1. No new features will be accepted.
182+
183+
## :memo: License
184+
185+
Licensed under the [MIT License](./LICENSE).
186+
187+
## 💜 Thanks to Our Contributors and Sponsors
188+
189+
Thanks to our many contributors and sponsors as well as the companies sponsoring
190+
our testing and hosting infrastructure: [Circle CI](https://circleci.com/), [Appveyor](https://www.appveyor.com/), and [Netlify](https://www.netlify.com/).
203 KB
Loading

0 commit comments

Comments
 (0)