forked from
quillmatiq.com/augment
Fork of Chiri for Astro for my blog
1# Chiri 🌸
2
3
4
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://astro-chiri.netlify.app/) for more details.
9
10## Features
11
12- Built with Astro
13- Responsive
14- Light / Dark mode
15- MDX
16- KaTeX
17- Sitemap
18- OpenGraph
19- RSS
20- ...
21
22## Getting Started
23
241. [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).
25
262. Run the following commands:
27
28 ```bash
29 git clone <your-repo-url>
30
31 cd <your-repo-name>
32
33 pnpm install
34
35 pnpm dev
36 ```
37
383. Edit `src/config.ts` and `src/content/about/about.md` to your liking.
39
404. Use `pnpm new <title>` to create new posts, or add your posts to `src/content/posts`.
41
425. 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:
43 - **Netlify**: `pnpm add @astrojs/netlify` and add `adapter: netlify()` in `astro.config.ts`.
44 - **Vercel**: `pnpm add @astrojs/vercel` and add `adapter: vercel()` in `astro.config.ts`.
45 - **Cloudflare Pages**: `pnpm add @astrojs/cloudflare` and add `adapter: cloudflare()` in `astro.config.ts`.
46 - **Static (e.g. GitHub Pages)**: `pnpm add @astrojs/static` and add `adapter: static()` in `astro.config.ts`.
47 - Refer to [Astro Deployment Guides](https://docs.astro.build/en/guides/deploy/) for more details.
48
49 [](https://app.netlify.com/start) [](https://vercel.com/new) [](https://pages.cloudflare.com/start)
50
51## Commands
52
53- `pnpm new <title>` - Create a new post (use `_title` for drafts)
54- `pnpm update-theme` - Update the theme to the latest version
55
56## References
57
58- https://paco.me/
59- https://benji.org/
60- https://shud.in/
61- https://retypeset.radishzz.cc/
62
63## License
64
65MIT