Skip to content

VoxelMC/blog

Repository files navigation

Minimal

Minimal is a minimalistic astro theme for blogs.

Get started

Create a new repo from this template.

Features

  • Astro v4
  • Tailwind for styling
  • Responsive & SEO-friendly
  • Dark/Light mode support
  • MD & MDX posts
  • Shiki code syntax styling
  • Icons by Svgrepo

Configure

  • Go to astro.config.mjs and change site
  • Go to src/config.ts and configure data for meta tags
  • You can also customize colors of entire layout by changing colors in tailwind config.
  • You can customize theme for code blocks

How to add new post

Create a new md/mdx file inside src/pages/posts, and make sure it's in this format:

---
layout: '../../layouts/BlogPost.astro'
title: 'First post'
description: 'Lorem ipsum dolor sit amet'
pubDate: 'Dec 22 2023'
tags: ['astro', 'blogging', 'learning']
---

Your post

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

License

MIT