Personal blog https://mzhang.io

Find a file

Michael Zhang b36a272815 All checks were successful ci/woodpecker/push/woodpecker Pipeline was successful Details enable syntax highlighting		2023-10-02 17:36:09 -05:00
.vscode	init astro	2023-08-30 19:30:45 -05:00
plugin	no extra padding on left on mobile	2023-09-01 10:12:29 -05:00
public	a	2023-08-31 08:39:21 -05:00
src	time to bury this forever	2023-09-21 17:40:43 -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	pragmata	2023-08-31 03:09:41 -05:00
.prettierrc.json	progress	2023-08-30 22:47:22 -05:00
.tokeignore	remove more technical stuff	2023-08-31 21:41:52 -05:00
.woodpecker.yml	dont be so verbose	2023-09-08 05:15:25 -05:00
astro.config.ts	enable syntax highlighting	2023-10-02 17:36:09 -05:00
package-lock.json	compiler?	2023-09-08 05:10:52 -05:00
package.json	compiler?	2023-09-08 05:10:52 -05:00
README.md	init astro	2023-08-30 19:30:45 -05:00
tsconfig.json	compiler?	2023-09-08 05:10:52 -05:00

README.md

Astro Starter Kit: Blog

npm create astro@latest -- --template blog

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

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.