astro/examples/blog
Dan Jutan 8ed924d2ed
Update README.md (#3597)
- Fix the tree to reflect the actual example contents
- Remove RSS and Sitemap bullet points, since they aren't in the project
2022-06-15 10:32:40 -05:00
..
.vscode [ci] format 2022-03-22 03:16:42 +00:00
public move styles to src (#2003) 2021-11-24 11:10:12 -08:00
src fix: updated blog template with existing address (#3312) 2022-05-11 16:20:00 -05:00
.gitignore refactor(vercel): Build Output API v3 (#3216) 2022-05-11 15:10:38 -06:00
.npmrc Move from yarn to pnpm (#2455) 2022-03-08 15:46:11 -06:00
.stackblitzrc update examples for stackblitz (#1379) 2021-09-16 08:06:22 -07:00
astro.config.mjs exit prerelease mode (#2967) 2022-04-02 13:37:28 -06:00
package.json [ci] release (#3596) 2022-06-14 15:46:51 -05:00
README.md Update README.md (#3597) 2022-06-15 10:32:40 -05:00
sandbox.config.json Adding CodeSandbox config file to all the "next" examples (#1744) 2021-11-05 10:41:37 -05:00
tsconfig.json Update example tsconfig (#3107) 2022-04-28 11:42:55 -04:00

Astro Starter Kit: Blog

npm init astro -- --template blog

Open in StackBlitz

🧑‍🚀 Seasoned astronaut? Delete this file. Have fun!

Features:

  • SEO-friendly setup with canonical URLs and OpenGraph data
  • Full Markdown support

🚀 Project Structure

Inside of your Astro project, you'll see the following folders and files:

├── README.md
├── astro.config.mjs
├── package.json
├── public
│   ├── assets
│   │   └── blog
│   │       └── introducing-astro.jpg
│   ├── favicon.ico
│   ├── social.jpg
│   └── social.png
├── sandbox.config.json
├── src
│   ├── components
│   │   ├── Author.astro
│   │   ├── BaseHead.astro
│   │   ├── BlogHeader.astro
│   │   ├── BlogPost.astro
│   │   ├── BlogPostPreview.astro
│   │   ├── Heading.astro
│   │   └── Logo.astro
│   ├── layouts
│   │   └── BlogPost.astro
│   ├── pages
│   │   ├── index.astro
│   │   └── posts
│   │       └── index.md
│   └── styles
│       └── blog.css
└── 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

👀 Want to learn more?

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