shawn-reuter-blog/README.md

65 lines
2.0 KiB
Markdown
Raw Normal View History

2021-12-01 18:00:25 +00:00
# [Astro](https://astro.build) Blog Template
2021-11-30 20:18:49 +00:00
2021-12-01 18:01:58 +00:00
[![Screenshot](screenshot.png)](https://astro-blog-template.netlify.app/)
2021-11-30 20:18:49 +00:00
2021-12-01 18:01:58 +00:00
## 👉 Check out the ✨ [Live Demo](https://astro-blog-template.netlify.app/) ✨
2021-12-01 18:00:25 +00:00
## 👩‍🚀 Getting Started
### Locally
```
npm init astro -- --template Charca/astro-blog-template
```
### On StackBlitz
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/charca/astro-blog-template)
## ✨ Features:
2022-08-12 17:41:07 +00:00
- ✅ Astro 1.0
2021-12-01 18:00:25 +00:00
- ✅ Dark Mode
- ✅ Full Markdown support
- ✅ SEO-friendly setup with canonical URLs and OpenGraph data
- ✅ RSS 2.0 generation
- ✅ Sitemap.xml generation
2021-11-30 20:18:49 +00:00
## 🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files:
```
/
├── public/
│ ├── robots.txt
│ └── favicon.ico
├── src/
│ ├── components/
│ │ └── Tour.astro
│ └── pages/
│ └── index.astro
└── package.json
```
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Any static assets, like images, can be placed in the `public/` directory.
## 🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
2022-08-12 17:41:07 +00:00
| :---------------- | :------------------------------------------- |
2021-11-30 20:18:49 +00:00
| `npm install` | Installs dependencies |
2021-12-01 18:00:25 +00:00
| `npm run dev` | Starts local dev server at `localhost:3030` |
2021-11-30 20:18:49 +00:00
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
## 👀 Want to learn more?
2021-12-01 18:00:25 +00:00
Feel free to check [Astro's documentation](https://github.com/withastro/astro) or jump into Astro's [Discord server](https://astro.build/chat).