Skip to content

README.md

Latest commit

 

History

History
74 lines (55 loc) · 2.66 KB

README.md

File metadata and controls

74 lines (55 loc) · 2.66 KB

Twenty Something Theme

From Wordpress to Astro

An Astro template loosely based on Wordpress' Twenty Twenty-Four theme.
Read the Guide

Features:

  • SEO-friendly with canonical URLs and OpenGraph data
  • Sitemap support
  • RSS Feed support
  • Markdown & MDX support
  • Open Props for styling
  • FrontMatter CMS integration

🚀 Project Structure

Inside of your Astro project, you'll see the following folders and files:

├── public/
├── src/
│   ├── assets/
│   ├── components/
│   ├── content/
│   ├── data/
│   ├── layouts/
│   ├── pages/
│   ├── styles/
│   ├── types/
│   └── utils/
├── astro.config.ts
├── frontmatter.json
├── generateStyle.mjs
├── package.json
├── postcss.config.mjs
├── README.md
└── 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

👀 Learn more about Astro

Check out our documentation or jump into our Discord server.

✅ Todo

  • Add page transitions
  • Add OpenGraph image based on featured image
  • Add basic search
  • Add Web3 form