Fork of Chiri for Astro for my blog
at main 63 lines 2.0 kB view raw view rendered
1# Chiri 🌸 2 3![screenshot-light](public/screenshots/screenshot-light.png) 4![screenshot-dark](public/screenshots/screenshot-dark.png) 5 6Chiri is a minimal blog theme built with [Astro](https://astro.build), offering customization options while preserving its clean aesthetic. 7 8Check the [demo](https://chiri.the3ash.com/) for more details. 9 10## Features 11 12- [x] Build with Astro 13- [x] Responsive 14- [x] Light / Dark mode 15- [x] MDX 16- [x] KaTeX 17- [x] Sitemap 18- [x] OpenGraph 19- [x] RSS 20 21## Getting Started 22 231. [Fork](https://github.com/the3ash/astro-chiri/fork) this repository, or use this template to [create a new repository](https://github.com/new?template_name=astro-chiri&template_owner=the3ash). 24 252. Run the following commands: 26 27 ```bash 28 git clone <your-repo-url> 29 30 cd <your-repo-name> 31 32 pnpm install 33 34 pnpm dev 35 ``` 36 373. Edit `src/config.ts` and `src/content/about/about.md` to your liking. 38 394. Use `pnpm new <title>` to create new posts, or add your posts to `src/content/posts`. 40 415. You need to set adapter as follows before deploying to Netlify, Vercel, or other platforms, but you can set `linkCard` to `false` in `src/config.ts` to skip this step: 42 - **Netlify**: `pnpm add @astrojs/netlify` and add `adapter: netlify()` in `astro.config.ts`. 43 - **Vercel**: `pnpm add @astrojs/vercel` and add `adapter: vercel()` in `astro.config.ts`. 44 - **Static (e.g. GitHub Pages)**: `pnpm add @astrojs/static` and add `adapter: static()` in `astro.config.ts`. 45 - Refer to [Astro Deployment Guides](https://docs.astro.build/en/guides/deploy/) for more details. 46 47&emsp;[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start) [![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/new) 48 49## Commands 50 51- `pnpm new <title>` - Create a new post (use `_title` for drafts) 52- `pnpm update-theme` - Update the theme to the latest version 53 54## References 55 56- https://paco.me/ 57- https://benji.org/ 58- https://shud.in/ 59- https://retypeset.radishzz.cc/ 60 61## License 62 63MIT