aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Joe Banks <[email protected]>2024-04-28 22:04:46 +0100
committerGravatar Joe Banks <[email protected]>2024-04-28 22:04:46 +0100
commitbd298c94f73598502121431965787b78edc22875 (patch)
tree9b7137e5f691680e94d04b16ccb0ee49a366237a /README.md
Initial commit from gatsby
Diffstat (limited to 'README.md')
-rw-r--r--README.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..52a93fe
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+<p align="center">
+ <a href="https://www.gatsbyjs.com/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter-ts">
+ <img alt="Gatsby" src="https://www.gatsbyjs.com/Gatsby-Monogram.svg" width="60" />
+ </a>
+</p>
+<h1 align="center">
+ Gatsby Minimal TypeScript Starter
+</h1>
+
+## ๐Ÿš€ Quick start
+
+1. **Create a Gatsby site.**
+
+ Use the Gatsby CLI to create a new site, specifying the minimal TypeScript starter.
+
+ ```shell
+ # create a new Gatsby site using the minimal TypeScript starter
+ npm init gatsby -- -ts
+ ```
+
+2. **Start developing.**
+
+ Navigate into your new siteโ€™s directory and start it up.
+
+ ```shell
+ cd my-gatsby-site/
+ npm run develop
+ ```
+
+3. **Open the code and start customizing!**
+
+ Your site is now running at http://localhost:8000!
+
+ Edit `src/pages/index.tsx` to see your site update in real-time!
+
+4. **Learn more**
+
+ - [Documentation](https://www.gatsbyjs.com/docs/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter-ts)
+ - [Tutorials](https://www.gatsbyjs.com/docs/tutorial/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter-ts)
+ - [Guides](https://www.gatsbyjs.com/docs/how-to/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter-ts)
+ - [API Reference](https://www.gatsbyjs.com/docs/api-reference/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter-ts)
+ - [Plugin Library](https://www.gatsbyjs.com/plugins?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter-ts)
+ - [Cheat Sheet](https://www.gatsbyjs.com/docs/cheat-sheet/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter-ts)
+
+## ๐Ÿš€ Quick start (Netlify)
+
+Deploy this starter with one click on [Netlify](https://app.netlify.com/signup):
+
+[<img src="https://www.netlify.com/img/deploy/button.svg" alt="Deploy to Netlify" />](https://app.netlify.com/start/deploy?repository=https://github.com/gatsbyjs/gatsby-starter-minimal-ts)