Infrastructure/astro
0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-23 21:53:55 -05:00
Code Issues Activity
astro/examples/blog-multiple-authors/README.md
Okiki eb4effb6b7
docs: seperate npm run build and npm run dev to avoid confusion (#1798) 
To avoid confusion I seperated the  `npm run build` and the `npm run dev` commands, beginners might get confused by each command being listed in the same list, thinking they need to run `npm run build` before Astro works properly.

Add `npm run preview` commands to all examples where they are missing
2021-11-11 13:28:51 -06:00

1.8 KiB
Raw Blame History

Astro Starter Kit: Blog with Multiple Authors

npm init astro -- --template blog-multiple-authors

Open in StackBlitz

🧑‍🚀 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/
npm run preview Preview your build locally, before deploying

👀 Want to learn more?

Feel free to check our documentation or jump into our Discord server.