Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ekmas/minimal
Minimalistic astro blog theme.
https://github.com/ekmas/minimal
astro astro-blog astro-theme blog-theme md mdx tailwind-theme
Last synced: 4 months ago
JSON representation
Minimalistic astro blog theme.
- Host: GitHub
- URL: https://github.com/ekmas/minimal
- Owner: ekmas
- License: mit
- Created: 2024-01-14T19:36:57.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-14T09:40:45.000Z (6 months ago)
- Last Synced: 2024-09-30T00:43:14.317Z (4 months ago)
- Topics: astro, astro-blog, astro-theme, blog-theme, md, mdx, tailwind-theme
- Language: Astro
- Homepage: https://astro-minimal.netlify.app/
- Size: 852 KB
- Stars: 23
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Minimal
Minimal is a minimalistic astro theme for blogs.
## Get started
[Create a new repo](https://github.com/ekmas/minimal/generate) from this template.
## Features
- Astro v4
- Tailwind for styling
- Responsive & SEO-friendly
- Dark/Light mode support
- MD & MDX posts
- View Transitions API
- Content collections
- Expressive-code code blocks
- Shiki code syntax styling
- Icons by [Svgrepo](https://www.svgrepo.com/)
## 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 code blocks config by changing `expressiveCode` object in astro config. Visit [expressive-code docs](https://expressive-code.com/reference/configuration) for more info.
- To change code blocks theme, you'll have to update themes both in `themes` array and in `config.ts`
## How to add new post
Create a new md/mdx file inside src/content/posts, and make sure it's in this format:
```
---
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