https://github.com/break-stuff/breakstuff
repo for the breakstuff.io blog
https://github.com/break-stuff/breakstuff
Last synced: about 1 year ago
JSON representation
repo for the breakstuff.io blog
- Host: GitHub
- URL: https://github.com/break-stuff/breakstuff
- Owner: break-stuff
- Created: 2021-10-05T19:50:23.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-05T19:52:26.000Z (over 4 years ago)
- Last Synced: 2025-02-09T12:17:54.088Z (over 1 year ago)
- Language: Astro
- Size: 1.84 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Astro Starter Kit: Blog
```
npm init astro -- --template blog
```
[](https://stackblitz.com/github/snowpackjs/astro/tree/latest/examples/blog)
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
Features:
- ✅ SEO-friendly setup with canonical URLs and OpenGraph data
- ✅ Full Markdown support
- ✅ RSS 2.0 generation
- ✅ Sitemap.xml generation
## 🚀 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 |
|:----------------|:--------------------------------------------|
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` |
## 👀 Want to learn more?
Feel free to check [our documentation](https://github.com/snowpackjs/astro) or jump into our [Discord server](https://astro.build/chat).