36 lines
2.3 KiB
Markdown
36 lines
2.3 KiB
Markdown
## 🧐 What's inside?
|
||
|
||
A quick look at the top-level files and directories you'll see in a Gatsby project.
|
||
|
||
.
|
||
├── node_modules
|
||
├── src
|
||
├── .gitignore
|
||
├── .prettierrc
|
||
├── gatsby-browser.js
|
||
├── gatsby-config.js
|
||
├── gatsby-node.js
|
||
├── gatsby-ssr.js
|
||
├── LICENSE
|
||
├── package-lock.json
|
||
├── package.json
|
||
└── README.md
|
||
|
||
1. **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.
|
||
|
||
2. **`/src`**: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. `src` is a convention for “source code”.
|
||
|
||
3. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.
|
||
|
||
4. **`.prettierrc`**: This is a configuration file for [Prettier](https://prettier.io/). Prettier is a tool to help keep the formatting of your code consistent.
|
||
|
||
5. **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.com/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser.
|
||
|
||
6. **`gatsby-config.js`**: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the [config docs](https://www.gatsbyjs.com/docs/gatsby-config/) for more detail).
|
||
|
||
7. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.com/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.
|
||
|
||
8. **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://www.gatsbyjs.com/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering.
|
||
|
||
9. **`README.md`**: A text file containing useful reference information about your project.
|