Personal blog https://mzhang.io
Find a file
Michael Zhang 4a89b35ba3
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
ok kinda working
2023-08-31 03:07:03 -05:00
.vscode init astro 2023-08-30 19:30:45 -05:00
plugin ok kinda working 2023-08-31 03:07:03 -05:00
public ok kinda working 2023-08-31 03:07:03 -05:00
src ok kinda working 2023-08-31 03:07:03 -05:00
.editorconfig Revert mastodon testing changes 2021-11-01 01:02:23 -05:00
.envrc Flake init 2023-02-04 01:21:21 -06:00
.gitignore init astro 2023-08-30 19:30:45 -05:00
.prettierrc.json progress 2023-08-30 22:47:22 -05:00
.woodpecker.yml ok kinda working 2023-08-31 03:07:03 -05:00
astro.config.ts ok kinda working 2023-08-31 03:07:03 -05:00
package-lock.json ok kinda working 2023-08-31 03:07:03 -05:00
package.json ok kinda working 2023-08-31 03:07:03 -05:00
README.md init astro 2023-08-30 19:30:45 -05:00
tsconfig.json progress 2023-08-30 22:47:22 -05:00

Astro Starter Kit: Blog

npm create astro@latest -- --template blog

Open in StackBlitz Open with CodeSandbox Open in GitHub Codespaces

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

blog

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/
│   ├── content/
│   ├── 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.

The src/content/ directory contains "collections" of related Markdown and MDX documents. Use getCollection() to retrieve posts from src/content/blog/, and type-check your frontmatter using an optional schema. See Astro's Content Collections docs to learn more.

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:4321
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.