Go to file
LimePotato 7a1c0ccc5d 202402022114 2024-02-02 21:14:39 -07:00
.vscode init 2024-02-02 18:05:34 -07:00
public 202402022019 2024-02-02 20:19:38 -07:00
src 202402022114 2024-02-02 21:14:39 -07:00
.gitignore init 2024-02-02 18:05:34 -07:00
README.md Update README.md 2024-02-02 18:09:10 -07:00
astro.config.mjs init 2024-02-02 18:05:34 -07:00
build.sh 202402021906 2024-02-02 19:06:52 -07:00
package-lock.json Update README.md 2024-02-02 18:09:10 -07:00
package.json init 2024-02-02 18:05:34 -07:00
tsconfig.json init 2024-02-02 18:05:34 -07:00

README.md

Egg Blog

Todo

  • Basic Template
  • Style
  • Auto git sync
  • Auto astro build

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