Skip to content

chaocwu/blog

Repository files navigation

Chiri 🌸

screenshot-light screenshot-dark

Chiri is a minimal blog theme built with Astro, offering customization options while preserving its clean aesthetic.

Check the demo for more details.

Features

  • Build with Astro
  • Responsive
  • Light / Dark mode
  • MDX
  • KaTeX
  • Sitemap
  • OpenGraph
  • RSS
  • Pagination

Getting Started

  1. Fork this repository, or use this template to create a new repository.

  2. Run the following commands:

    git clone <your-repo-url>
    
    cd <your-repo-name>
    
    pnpm install
    
    pnpm dev
  3. Edit src/config.ts and src/content/about/about.md to your liking.

  4. Use pnpm new <title> to create new posts, or add your posts to src/content/posts.

  5. 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:

    • Netlify: pnpm add @astrojs/netlify and add adapter: netlify() in astro.config.ts.
    • Vercel: pnpm add @astrojs/vercel and add adapter: vercel() in astro.config.ts.
    • Cloudflare Pages: pnpm add @astrojs/cloudflare and add adapter: cloudflare() in astro.config.ts.
    • Static (e.g. GitHub Pages): pnpm add @astrojs/static and add adapter: static() in astro.config.ts.
    • Refer to Astro Deployment Guides for more details.

Deploy to Netlify Deploy to Vercel Deploy to Cloudflare Pages

Commands

  • pnpm new <title> - Create a new post (use _title for drafts)
  • pnpm update-theme - Update the theme to the latest version

References

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published