michael
/
blog
1
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity
Personal blog https://mzhang.io
360 Commits 4 Branches 0 Tags 24 MiB
SCSS 66.6%
MDX 14.6%
Astro 9.2%
TypeScript 7.2%
Dockerfile 1.2%
Other 1.2%
Go to file
Michael Zhang 0adaf0c122
ci/woodpecker/push/woodpecker Pipeline failed Details
try node 20 		2023-10-24 14:05:09 -05:00
.vscode init astro 2023-08-30 19:30:45 -05:00
plugin sad 2023-10-12 17:22:58 -05:00
public a 2023-08-31 08:39:21 -05:00
src undraft path induction post 2023-10-24 14:02:45 -05:00
utils add packages 2023-10-11 17:30:50 -05:00
.dockerignore docker shit 2023-10-11 13:09:15 -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 builder 2023-10-11 14:46:16 -05:00
.prettierignore sad 2023-10-12 17:22:58 -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 try node 20 2023-10-24 14:05:09 -05:00
README.md init astro 2023-08-30 19:30:45 -05:00
astro.config.ts sad 2023-10-12 17:22:58 -05:00
blog.agda-lib sad 2023-10-12 17:22:58 -05:00
package.json more sane date format 2023-10-23 21:50:45 -05:00
pnpm-lock.yaml more sane date format 2023-10-23 21:50: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

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.