gatsby README

The project's README from github.com/gatsbyjs/gatsby. As one markdown file: README.md.

Gatsby

Gatsby

The future of web development is here.

Gatsby is a free and open-source framework based on React that helps developers build blazing fast websites and apps.
It combines the control and scalability of dynamically rendered sites with the speed of static-site generation, creating a whole new web of possibilities.

Gatsby is released under the MIT license. Current CircleCI build status. Current npm package version. Downloads per month on npm. Total downloads on npm. PRs welcome!

Quickstart · Tutorial · Plugins · Starters · Showcase · Contribute
Support: Discussions

Gatsby helps professional developers efficiently create maintainable, highly-performant, content-rich websites.

Learn how to use Gatsby for your next project.

🚀 Ship your first Gatsby site in 5 Minutes

Click the link below to quickly try the workflow of developing, building, and deploying websites with Gatsby and Netlify.

Deploy to Netlify

At the end of this process, you'll have

  1. a site working on Netlify
  2. a new repository that is linked to that new site
  3. as you push changes to your new repository, Netlify will automatically rebuild and redeploy your site!

💻 Get started with Gatsby locally in 5 Minutes

You can get a new Gatsby site up and running on your local dev environment in 5 minutes with these four steps:

  1. Initialize a new project.

    npm init gatsby
    

    Give it the name "My Gatsby Site".

  2. Start the site in develop mode.

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

    cd my-gatsby-site/
    npm run develop
    
  3. Open the source code and start editing!

    Your site is now running at http://localhost:8000. Open the my-gatsby-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!

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 and the official tutorial.

🎓 Learning Gatsby

Full documentation for Gatsby lives on the website.

We welcome suggestions for improving our docs. See the “how to contribute” documentation for more details.

Start Learning Gatsby: Follow the Tutorial · Read the Docs

🚢 Release Notes

Wondering what we've shipped recently? Check out our release notes for key highlights, performance improvements, new features, and notable bugfixes.

Also, read our documentation on version support to understand our plans for each version of Gatsby.

💼 Migration Guides

Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v5 to your site without starting from scratch!

❗ Code of Conduct

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. Please read it. Please follow it. In the Gatsby community, we work hard to build each other up and create amazing things together. 💪💜

🤝 How to Contribute

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!

Check out our Contributing Guide for ideas on contributing and setup steps for getting our repositories up and running on your local machine.

A note on how this repository is organized

This repository is a monorepo managed using Lerna. This means there are multiple packages managed in this codebase, even though we publish them to NPM as separate packages.

📝 License

Licensed under the MIT License.

💜 Thanks

Thanks go out to all our many contributors creating plugins, starters, videos, and blog posts. And a special appreciation for our community members helping with issues and PRs, or answering questions on GitHub Discussions.

A big part of what makes Gatsby great is each and every one of you in the community. Your contributions enrich the Gatsby experience and make it better every day.

gatsby (gatsbyjs/gatsby)

Searching Database…

55.9K ·GitHub
Что это такое?Gatsby — это бесплатный фреймворк с открытым исходным кодом на основе React для создания быстрых сайтов и веб-приложений. Он сочетает контроль динамически генерируемых сайтов со скоростью статической генерации.
Это строго генератор статических сайтов?Статическая генерация используется по умолчанию, но любую страницу можно перевести на отложенную статическую генерацию (Deferred Static Generation) или рендеринг на сервере (Server-Side Rendering). В итоге получается полноценное React-приложение — блог, интернет-магазин, панель управления.
Как выглядит запуск первого сайта на своём компьютере?Создайте новый проект, перейдите в его папку и запустите сайт в режиме разработки, затем отредактируйте src/pages/index.js — браузер обновляется в реальном времени. По оценке README, всё это занимает около пяти минут.
Что должно быть установлено на компьютере перед созданием проекта?В репозитории указаны Node.js версии 18 или новее (но ниже 26) и npm 8+ или Yarn 1.17+. Больше ничего не нужно — ни базы данных, ни внешних сервисов, чтобы начать разработку.
Мне обязательно использовать React и GraphQL?Да — каким бы ни был источник данных, сайты собираются на React и GraphQL, так что именно с этим стеком вам и предстоит работать.
Где в итоге работают созданные мной сайты?Gatsby — это инструмент на базе Node, который запускается на вашем компьютере; на выходе получаются обычные сайты и веб-приложения, которые открываются в любом браузере.
Нужен ли мне свой сервер, чтобы готовый сайт оставался в сети?Нет. Сайтам на Gatsby сервер не требуется — весь сайт можно разместить на CDN, а многие работают совершенно бесплатно на Netlify и подобных сервисах.
Можно ли использовать Gatsby в коммерческих проектах?Никто не мешает: код распространяется по лицензии MIT, так что коммерческое использование разрешено.
Откуда может браться мой контент?Откуда угодно — из Markdown-файлов, headless CMS вроде Contentful или WordPress, либо из REST- или GraphQL API. Плагины-источники загружают всё в единую унифицированную базу данных на GraphQL, с которой удобно работать при разработке.
Что он делает для производительности без моей просьбы?Разбиение кода, оптимизация изображений, встраивание критических стилей, ленивую загрузку и предзагрузку — всё это автоматизировано, поэтому сайты по умолчанию отлично проходят проверки производительности без ручной настройки.
Насколько крутая кривая обучения?Пологая по замыслу: подробный официальный туториал стартует с нуля, не делая никаких предположений о вашем уровне, и проводит через каждый шаг, а в документации есть дополнительные руководства, справочник и разбор концепций.
Creator
gatsbyjs
Size
1.1 GB
Stars
55.9K
Age
11y
Commits · 90 Days