0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-16 21:46:22 -05:00
astro/examples/blog
Fred K. Schott d54588c7a4
Update: blog template (#4283)
* add new blog template

* update placeholder images

* use svg favicon

* Update examples/blog/src/pages/blog/using-mdx.mdx

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

* fred pass

* more fred pass

Co-authored-by: Nate Moore <nate@astro.build>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
2022-08-13 00:09:40 -07:00
..
.vscode [ci] format 2022-03-22 03:16:42 +00:00
public Update: blog template (#4283) 2022-08-13 00:09:40 -07:00
src Update: blog template (#4283) 2022-08-13 00:09:40 -07: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
astro.config.mjs Update: blog template (#4283) 2022-08-13 00:09:40 -07:00
package.json Update: blog template (#4283) 2022-08-13 00:09:40 -07:00
README.md Update: blog template (#4283) 2022-08-13 00:09:40 -07:00
sandbox.config.json
tsconfig.json Move types to a .d.ts file inside examples projects (#4171) 2022-08-05 17:46:52 -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
  • @astrojs/image image optimizations
  • Sitemap support
  • Markdown & MDX support
  • Minimal styling (make it your own!)
  • 100/100 Lighthouse performance

🚀 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 or jump into our Discord server.

Credit

This theme is based off of the lovely Bear Blog.