Package detail

gatsby-source-filesystem

gatsbyjs847.6kMIT5.14.0

Gatsby source plugin for building websites from local data. Markdown, JSON, images, YAML, CSV, and dozens of other data types supported.

gatsby, gatsby-plugin

readme

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.

Quickstart · Tutorial · Plugins · Starters · Showcase · Contribute
Support: Twitter, Discussions & Discord

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

Load Data From Anywhere. Gatsby pulls in data from any data source, whether it’s Markdown files, a headless CMS like Contentful or WordPress, or a REST or GraphQL API. Use source plugins to load your data, then develop using Gatsby’s uniform GraphQL interface.
Go Beyond Static Websites. Get all the benefits of static websites with none of the limitations. Gatsby sites are fully functional React apps, so you can create high-quality, dynamic web apps, from blogs to e-commerce sites to user dashboards.
Choose your Rendering Options. You can choose alternative rendering options, namely Deferred Static Generation (DSG) and Server-Side Rendering (SSR), in addition to Static Site Generation (SSG) — on a per-page basis. This type of granular control allows you to optimize for performance and productivity without sacrificing one for the other.
Performance Is Baked In. Ace your performance audits by default. Gatsby automates code splitting, image optimization, inlining critical styles, lazy-loading, prefetching resources, and more to ensure your site is fast — no manual tuning required.
Use a Modern Stack for Every Site. No matter where the data comes from, Gatsby sites are built using React and GraphQL. Build a uniform workflow for you and your team, regardless of whether the data is coming from the same backend.
Host at Scale for Pennies. Gatsby sites don’t require servers, so you can host your entire site on a CDN for a fraction of the cost of a server-rendered site. Many Gatsby sites can be hosted entirely free on Gatsby Cloud and other similar services.
Use Gatsby's Centralized Data Layer Everywhere. With Gatsby's Valhalla Content Hub you can bring Gatsby's data layer to any project. Making it accessible via a unified GraphQL API for building content sites, eCommerce platforms, and both native and web applications.

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 Gatsby Cloud.

At the end of this process, you'll have

a site working on Gatsby Cloud
a new repository that is linked to that new site
as you push changes to your new repository, Gatsby Cloud 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:

Initialize a new project.
```
npm init gatsby
```
Give it the name "My Gatsby Site".
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
```
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.

For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.
To dive straight into code samples head to our documentation. In particular, check out the “How-to Guides”, “Reference”, and “Conceptual Guides” sections in the sidebar.

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 Discord and 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.

changelog

Changelog: `gatsby-source-filesystem`

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

5.13.1 (2024-01-23)

Note: Version bump only for package gatsby-source-filesystem

Package detail

readme

Gatsby

Quickstart · Tutorial · Plugins · Starters · Showcase · Contribute Support: Twitter, Discussions & Discord

🚀 Ship your first Gatsby site in 5 Minutes

💻 Get started with Gatsby locally in 5 Minutes

🎓 Learning Gatsby

🚢 Release Notes

💼 Migration Guides

❗ Code of Conduct

🤝 How to Contribute

A note on how this repository is organized

📝 License

💜 Thanks

changelog

Changelog: gatsby-source-filesystem

5.13.1 (2024-01-23)

5.13.0 (2023-12-18)

5.12.1 (2023-10-26)

5.12.0 (2023-08-24)

Bug Fixes

5.11.0 (2023-06-15)

5.10.0 (2023-05-16)

Bug Fixes

5.9.0 (2023-04-18)

Bug Fixes

5.8.0 (2023-03-21)

5.7.0 (2023-02-21)

5.6.0 (2023-02-07)

Bug Fixes

5.5.0 (2023-01-24)

Features

Chores

5.4.0 (2023-01-10)

Chores

5.3.1 (2022-12-14)

5.3.0 (2022-12-13)

Bug Fixes

5.2.0 (2022-11-25)

5.1.0 (2022-11-22)

Bug Fixes

5.0.0 (2022-11-08)

Chores

4.24.0 (2022-09-27)

4.23.0 (2022-09-13)

4.22.0 (2022-08-30)

Chores

4.21.1 (2022-08-18)

Chores

4.21.0 (2022-08-16)

Bug Fixes

Chores

4.20.0 (2022-08-02)

4.19.0 (2022-07-19)

4.18.1 (2022-07-12)

4.18.0 (2022-07-05)

Bug Fixes

4.17.0 (2022-06-21)

4.16.0 (2022-06-07)

Bug Fixes

4.15.0 (2022-05-24)

4.14.0 (2022-05-10)

Bug Fixes

4.13.0 (2022-04-26)

4.12.1 (2022-04-13)

4.12.0 (2022-04-12)

Bug Fixes

4.11.1 (2022-03-31)

4.11.0 (2022-03-29)

Bug Fixes

Chores

4.10.1 (2022-03-23)

4.10.0 (2022-03-16)

4.9.1 (2022-03-09)

4.9.0 (2022-03-01)

Chores

4.8.2 (2022-03-01)

4.8.1 (2022-02-25)

4.8.0 (2022-02-22)

Features

Quickstart · Tutorial · Plugins · Starters · Showcase · Contribute
Support: Twitter, Discussions & Discord

Changelog: `gatsby-source-filesystem`