|
1 | | -<!-- AUTO-GENERATED-CONTENT:START (STARTER) --> |
2 | | -<p align="center"> |
3 | | - <a href="https://www.gatsbyjs.com"> |
4 | | - <img alt="Gatsby" src="https://www.gatsbyjs.com/Gatsby-Monogram.svg" width="60" /> |
5 | | - </a> |
6 | | -</p> |
7 | | - |
8 | | - |
9 | | -1. **Create a Gatsby site.** |
10 | | - |
11 | | - Use the Gatsby CLI ([install instructions](https://www.gatsbyjs.com/docs/tutorial/part-0/#gatsby-cli)) to create a new site, specifying the blog starter. |
12 | | - |
13 | | - ```shell |
14 | | - # create a new Gatsby site using the blog starter |
15 | | - gatsby new my-blog-starter https://github.com/gatsbyjs/gatsby-starter-blog |
16 | | - ``` |
17 | | - |
18 | | -1. **Start developing.** |
19 | | - |
20 | | - Navigate into your new site’s directory and start it up. |
21 | | - |
22 | | - ```shell |
23 | | - cd my-blog-starter/ |
24 | | - gatsby develop |
25 | | - ``` |
26 | | - |
27 | | -1. **Open the source code and start editing!** |
28 | | - |
29 | | - Your site is now running at `http://localhost:8000`! |
30 | | - |
31 | | - _Note: You'll also see a second link: _`http://localhost:8000/___graphql`_. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the [Gatsby Tutorial](https://www.gatsbyjs.com/docs/tutorial/part-4/#use-graphiql-to-explore-the-data-layer-and-write-graphql-queries)._ |
32 | | -
|
33 | | - Open the `my-blog-starter` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes and the browser will update in real time! |
34 | | -
|
35 | | -## 🚀 Quick start (Gatsby Cloud) |
36 | | -
|
37 | | -Deploy this starter with one click on [Gatsby Cloud](https://www.gatsbyjs.com/cloud/): |
38 | | -
|
39 | | -[<img src="https://www.gatsbyjs.com/deploynow.svg" alt="Deploy to Gatsby Cloud">](https://www.gatsbyjs.com/dashboard/deploynow?url=https://github.com/gatsbyjs/gatsby-starter-blog) |
40 | | -
|
41 | | -## 🧐 What's inside? |
42 | | - |
43 | | -A quick look at the top-level files and directories you'll see in a Gatsby project. |
44 | | -
|
45 | | - . |
46 | | - ├── node_modules |
47 | | - ├── src |
48 | | - ├── .gitignore |
49 | | - ├── .prettierrc |
50 | | - ├── gatsby-browser.js |
51 | | - ├── gatsby-config.js |
52 | | - ├── gatsby-node.js |
53 | | - ├── gatsby-ssr.js |
54 | | - ├── LICENSE |
55 | | - ├── package-lock.json |
56 | | - ├── package.json |
57 | | - └── README.md |
58 | | -
|
59 | | -1. **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed. |
60 | | -
|
61 | | -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”. |
62 | | -
|
63 | | -3. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for. |
64 | | -
|
65 | | -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. |
66 | | -
|
67 | | -5. **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.com/docs/reference/config-files/gatsby-browser/) (if any). These allow customization/extension of default Gatsby settings affecting the browser. |
68 | | -
|
69 | | -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/reference/config-files/gatsby-config/) for more detail). |
70 | | -
|
71 | | -7. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.com/docs/reference/config-files/gatsby-node/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process. |
72 | | -
|
73 | | -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/reference/config-files/gatsby-ssr/) (if any). These allow customization of default Gatsby settings affecting server-side rendering. |
74 | | -
|
75 | | -9. **`LICENSE`**: This Gatsby starter is licensed under the 0BSD license. This means that you can see this file as a placeholder and replace it with your own license. |
76 | | -
|
77 | | -10. **`package-lock.json`** (See `package.json` below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. **(You won’t change this file directly).** |
78 | | -
|
79 | | -11. **`package.json`**: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project. |
80 | | -
|
81 | | -12. **`README.md`**: A text file containing useful reference information about your project. |
82 | | -
|
83 | | -## 🎓 Learning Gatsby |
84 | | -
|
85 | | -Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.com/). Here are some places to start: |
86 | | -
|
87 | | -- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.com/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process. |
88 | | -
|
89 | | -- **To dive straight into code samples, head [to our documentation](https://www.gatsbyjs.com/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar. |
90 | | -
|
91 | | -## 💫 Deploy |
92 | | -
|
93 | | -[Build, Deploy, and Host On The Only Cloud Built For Gatsby](https://www.gatsbyjs.com/products/cloud/) |
94 | | -
|
95 | | -Gatsby Cloud is an end-to-end cloud platform specifically built for the Gatsby framework that combines a modern developer experience with an optimized, global edge network. |
96 | | -
|
97 | | -<!-- AUTO-GENERATED-CONTENT:END --> |
| 1 | +init |
0 commit comments