mirror of
https://github.com/withastro/astro.git
synced 2024-12-16 21:46:22 -05:00
a800bf7ec1
* .md only: npm init astro --> npm create astro For consistency with https://github.com/withastro/docs/pull/360. Docs always use `npm create astro` (never `npm init astro`), README.md files in this repo should do the same. Search: `\b(npm|yarn|pnpm) init astro\b` Replace: `$1 create astro` Except for two instances: 1. `packages/create-astro/CHANGELOG.md` -- skipped because changelog. 2. `packages/create-astro/test/create-astro.test.js.skipped` -- skipped, old test disabled in https://github.com/withastro/astro/pull/3168. * docs: add `@latest` to `npm create astro` Co-authored-by: Bjorn Lu <bjorn@bjornlu.com> Co-authored-by: Michael Rienstra <michael@goodmoney.com>
64 lines
2.2 KiB
Markdown
64 lines
2.2 KiB
Markdown
# Astro Starter Kit: Blog
|
|
|
|
```
|
|
npm create astro@latest -- --template blog
|
|
```
|
|
|
|
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/blog)
|
|
|
|
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
|
|
|
|
|
|
![blog](https://user-images.githubusercontent.com/4677417/186189140-4ef17aac-c3c9-4918-a8c2-ce86ba1bb394.png)
|
|
|
|
Features:
|
|
|
|
- ✅ Minimal styling (make it your own!)
|
|
- ✅ 100/100 Lighthouse performance
|
|
- ✅ SEO-friendly with canonical URLs and OpenGraph data
|
|
- ✅ Sitemap support
|
|
- ✅ RSS Feed support
|
|
- ✅ Markdown & MDX support
|
|
|
|
## 🚀 Project Structure
|
|
|
|
Inside of your Astro project, you'll see the following folders and files:
|
|
|
|
```
|
|
├── public/
|
|
├── src/
|
|
│ ├── components/
|
|
│ ├── layouts/
|
|
│ └── pages/
|
|
├── astro.config.mjs
|
|
├── README.md
|
|
├── package.json
|
|
└── tsconfig.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/` |
|
|
| `npm run preview` | Preview your build locally, before deploying |
|
|
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
|
|
| `npm run astro --help` | Get help using the Astro CLI |
|
|
|
|
## 👀 Want to learn more?
|
|
|
|
Check out [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
|
|
|
|
## Credit
|
|
|
|
This theme is based off of the lovely [Bear Blog](https://github.com/HermanMartinus/bearblog/).
|