docs: expand README + add CLAUDE.md for dev guidance
This commit is contained in:
@@ -1 +1,46 @@
|
||||
# Jimmy Gan Blog
|
||||
# Jimmy Gan Blog
|
||||
|
||||
Personal website and blog built with [Astro](https://astro.build/) and deployed on [Cloudflare Pages](https://pages.cloudflare.com/).
|
||||
|
||||
## 🚀 Features
|
||||
|
||||
- **Astro 5**: Modern web framework for content-driven websites.
|
||||
- **TypeScript**: Typed JavaScript for better developer experience.
|
||||
- **Cloudflare Pages**: High-performance hosting with SSR support.
|
||||
- **MDX Support**: Use React components in Markdown.
|
||||
- **Sitemap & RSS**: Built-in support for SEO and feed readers.
|
||||
|
||||
## 🛠️ Development
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Node.js (Latest LTS recommended)
|
||||
- npm
|
||||
|
||||
### Setup
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
### Commands
|
||||
|
||||
| Command | Action |
|
||||
| :--- | :--- |
|
||||
| `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 with Wrangler |
|
||||
| `npm run deploy` | Build and deploy to Cloudflare Pages |
|
||||
| `npm run check` | Run type-checks and dry-run deployment |
|
||||
|
||||
## 📁 Project Structure
|
||||
|
||||
- `src/content/`: Blog posts and other content collections.
|
||||
- `src/pages/`: File-based routing for your pages.
|
||||
- `src/components/`: Reusable Astro components.
|
||||
- `src/layouts/`: Page layouts.
|
||||
- `public/`: Static assets like images and favicons.
|
||||
|
||||
## 📄 License
|
||||
|
||||
All rights reserved.
|
||||
|
||||
Reference in New Issue
Block a user