Use
separate-content-repo
branch if you want to have separate repositories for code and content as mentioned in this guide.
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
- ✅ TinaCMS integration
- ✅ Cloudinary integration for asset management
- ✅ Vercel deployment ready
Hydbrid or server output targets will need additional configuration for Vercel deployment. Read more here.
- Asset management using Cloudinary does not work in dev environment as serverless function to handle media interactions is not available.
Inside of your Astro project, you'll see the following folders and files:
├── api/
│ ├── cloudinary/
│ ├── [...media].js
├── public/
├── src/
│ ├── components/
│ ├── content/
│ ├── layouts/
│ └── pages/
├── tina/
├── 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.
The tina
directory contains files related to TinaCMS. The TinaCMS documentation for Astro integration can be found here
Vercel serverless function required to authenticate the Cloudinary media interactions is added in api/
directory. Refer Tina docs for more details.
All commands are run from the root of the project, from a terminal:
Command | Action |
---|---|
npm install |
Installs dependencies |
npm run dev |
Starts TinaCMS server and 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 |
This theme is based off of the lovely Bear Blog.