Skip to content

README.md

Latest commit

 

History

History
54 lines (40 loc) · 2.33 KB

README.md

File metadata and controls

54 lines (40 loc) · 2.33 KB

David Sint's Blog

This repo uses the Astro framework and is based on the template blog.

  • ✅ 100/100 Lighthouse performance
  • ✅ SEO-friendly with canonical URLs and OpenGraph data
  • ✅ Sitemap support
  • ✅ RSS Feed support
  • ✅ Markdown & MDX support

🚀 Project Structure

Inside of this Astro project, there is 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 the Astro/React/Vue/Svelte/Preact components reside.

The src/content/ directory contains "collections" of related Markdown and MDX documents. getCollection() is used to retrieve posts from src/content/blog/, and type-check the frontmatter using the schema.

Any static assets, like images, are 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
npm run format:fix Run the Biome formatter to write fixes
npm run linter:fix Run the Biome linter to write fixes
npm run check:fix Run the Biome formatter & linter to write fixes

Credit

This theme is based off of the Astro Blog template which is based off of Bear Blog.