astro-cactus v1.3.0
Astro Theme Cactus is a simple opinionated starter built with the Astro framework. Use it to create an easy-to-use blog or website.
💻 Live Demo hosted on Netlify
Features
Made with Astro, Typescript, and TailwindCSS
- Astro Fast 🚀
- Accessible, semantic HTML markup
- Responsive & SEO-friendly
- Astro Image Integration for optimised images
- MDX posts
- Pagination
- Theming colour modes with Tailwind and CSS variables
- Shiki code syntax styling
- Auto-generated sitemap
Quick start
Create a new repo from this template.
Commands
Replace pnpm with your choice of npm / yarn
| Command | Action |
|---|---|
pnpm install | Installs dependencies |
pnpm dev | Starts local dev server at localhost:3000 |
pnpm build | Build your production site to ./dist/ |
pnpm preview | Preview your build locally, before deploying |
Configure
- Edit config file
src/site-meta.config.tsfor basic site meta data - Update file
astro.config.mjssite property with your own domain - Replace & update files within the
/publicfolder:- favicon.ico
/imagesfolder - add your own icon- robots.txt - update the Sitemap url to your own domain
- manifest.webmanifest
- Modify file
src/styles/global.csswith your own light and dark styles - Create / edit posts for your blog within
src/pages/posts/with .md file(s) - Optional:
- Fonts: This theme sets the body element to the font family
font-mono, located in the global css filesrc/styles/global.css. You can change fonts by removing the variantfont-mono, after which TailwindCSS will default to thefont-sansfont family stack.
- Fonts: This theme sets the body element to the font family
Adding posts
Adding a post is a simple as adding your .mdx file(s) to the src/pages/posts/ folder, the name of which will be used as the slug/url. The two posts included with this template can be modified, and give you an example of how to structure your posts. Astro docs also has a detailed section on markdown pages.
Frontmatter
| Property (* required) | Description |
|---|---|
| layout | This is used to import Markdown Layouts, this theme uses src/layouts/BlogPost.astro as a wrapper for all blog posts. |
| title * | Self explanatory. Used as the text link to the post, the h1 on the posts' page, and the pages' title property |
| description * | Similar to above, used as the seo description property |
| publishDate * | Again pretty simple. To change the date format/locale, currently en-GB, update/pass the locale arg to function getLocaleTime, found in src/util.ts. |
| tags | Tags are optional. Any new tag(s) will be shown in yourdomain.com/posts + yourdomain.com/tags, and generate the page(s) yourdomain.com/tags/[yourTag] |
Deploy
Astro docs has a great section and breakdown of how to deploy your own Astro site on various platforms and their idiosyncrasies.
By default the site will be built (see Commands section above) to a /dist directory.
Acknowledgment
This theme is inspired by Hexo Theme Cactus
License
Licensed under the MIT License, Copyright © 2022
2 years ago