Go to file
Chris W 69b1046125 formatting 2024-01-03 16:20:45 -07:00
.frontmatter/database rolling my own pastebin 2024-01-03 16:04:22 -07:00
.vscode rolling my own pastebin 2024-01-03 16:04:22 -07:00
public rolling my own pastebin 2024-01-03 16:04:22 -07:00
src formatting 2024-01-03 16:20:45 -07:00
.gitignore new site 2023-12-08 14:30:53 -07:00
README.md new site 2023-12-08 14:30:53 -07:00
astro.config.mjs styles; inkify 2023-12-08 17:46:05 -07:00
bun.lockb rolling my own pastebin 2024-01-03 16:04:22 -07:00
frontmatter.json rss and blog/project headers 2023-12-09 11:13:22 -07:00
package.json rolling my own pastebin 2024-01-03 16:04:22 -07:00
tailwind.config.mjs styles; inkify 2023-12-08 17:46:05 -07:00
tsconfig.json styles; inkify 2023-12-08 17:46:05 -07: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.