docs: Update README with Notion integration and migration features

Author: KiritoKing

README.md

@@ -1,64 +1,156 @@
-# 🍥Fuwari
+# Notion Astro Rev - A Notion-Astro Blog Template
 
-A static blog template built with [Astro](https://astro.build).
+> Base Blog Template: [fuwari](https://github.com/saicaca/fuwari)
+>
+> This doc is generated by Claude 3.7 & Windsurf based on project info
 
-[**🖥️ Live Demo (Vercel)**](https://fuwari.vercel.app)   /   
-[**📦 Old Hexo Version**](https://github.com/saicaca/hexo-theme-vivia)   /   
-[**🌏 中文**](https://github.com/saicaca/fuwari/blob/main/README.zh-CN.md)   /   
-[**🌏 日本語**](https://github.com/saicaca/fuwari/blob/main/README.ja-JP.md)   /   
-[**🌏 한국어**](https://github.com/saicaca/fuwari/blob/main/README.ko.md)   /   
-[**🌏 Español**](https://github.com/saicaca/fuwari/blob/main/README.es.md)   /   
-[**🌏 ไทย**](https://github.com/saicaca/fuwari/blob/main/README.th.md)
+A modern blog template built with [Astro](https://astro.build) and powered by [notion-astro-loader](https://github.com/KiritoKing/notion-astro-loader) for seamless Notion integration.
 
-> README version: `2024-09-10`
+[**🌏 中文文档**](./README.zh-CN.md)
 
-![Preview Image](https://raw.githubusercontent.com/saicaca/resource/main/fuwari/home.png)
+> README version: `2025-04-17`
+
+## 🌟 Introduction
+
+This project serves as a template blog for the `notion-astro-loader` package, allowing you to create a beautiful, fast, and SEO-friendly blog using Notion as your CMS. With this template, you can:
+
+- Write and manage your blog content in Notion
+- Automatically sync content to your Astro-powered blog
+- Enjoy a modern, responsive design with smooth animations
+- Customize the appearance to match your personal style
+- Easily deploy to platforms like Vercel, Netlify, or GitHub Pages
 
 ## ✨ Features
 
-- [x] Built with [Astro](https://astro.build) and [Tailwind CSS](https://tailwindcss.com)
-- [x] Smooth animations and page transitions
-- [x] Light / dark mode
-- [x] Customizable theme colors & banner
-- [x] Responsive design
-- [ ] Comments
-- [x] Search
-- [ ] TOC
-
-## 🚀 How to Use
-
-1. [Generate a new repository](https://github.com/saicaca/fuwari/generate) from this template or fork this repository.
-2. To edit your blog locally, clone your repository, run `pnpm install` AND `pnpm add sharp` to install dependencies.
-   - Install [pnpm](https://pnpm.io) `npm install -g pnpm` if you haven't.
-3. Edit the config file `src/config.ts` to customize your blog.
-4. Run `pnpm new-post <filename>` to create a new post and edit it in `src/content/posts/`.
-5. Deploy your blog to Vercel, Netlify, GitHub Pages, etc. following [the guides](https://docs.astro.build/en/guides/deploy/). You need to edit the site configuration in `astro.config.mjs` before deployment.
-
-## ⚙️ Frontmatter of Posts
-
-```yaml
----
-title: My First Blog Post
-published: 2023-09-09
-description: This is the first post of my new Astro blog.
-image: ./cover.jpg
-tags: [Foo, Bar]
-category: Front-end
-draft: false
-lang: jp      # Set only if the post's language differs from the site's language in `config.ts`
----
+- [x] **Notion Integration**: Use Notion as your CMS with `notion-astro-loader`
+- [x] **Modern Design**: Built with Astro and Tailwind CSS
+- [x] **Performance**: Static site generation for optimal speed
+- [x] **Smooth Transitions**: Page transitions and animations
+- [x] **Theming**: Light/dark mode and customizable theme colors
+- [x] **Responsive**: Mobile-friendly design
+- [x] **Search**: Built-in search functionality
+- [x] **URL Migration**: Tools for migrating from other blog platforms
+- [x] **E2E Testing**: Playwright tests for URL redirects and functionality
+
+## 🚀 Getting Started
+
+### Prerequisites
+
+- [Node.js](https://nodejs.org/) (v18 or later)
+- [pnpm](https://pnpm.io/) (recommended package manager)
+- A Notion account with a database for your blog posts
+
+### Setup
+
+1. Clone this repository:
+
+   ```bash
+   git clone https://github.com/KiritoKing/notion-astro-rev.git
+   cd notion-astro-rev
+   ```
+
+2. Install dependencies:
+
+   ```bash
+   pnpm install
+   pnpm add sharp
+   ```
+
+3. Create a `.env` file in the root directory with your Notion credentials:
+
+   ```env
+   NOTION_TOKEN=your_notion_integration_token
+   NOTION_DATABASE_ID=your_notion_database_id
+   ```
+
+4. Start the development server:
+
+   ```bash
+   pnpm dev
+   ```
+
+5. Open your browser and navigate to `http://localhost:4321`
+
+### Tech Stack
+
+- **[Astro](https://astro.build)**: Fast, modern static site generator
+- **[Tailwind CSS](https://tailwindcss.com)**: Utility-first CSS framework
+- **[Svelte](https://svelte.dev)**: Component framework for interactive elements
+- **[notion-astro-loader](https://github.com/KiritoKing/notion-astro-loader)**: Notion integration for Astro
+- **[Playwright](https://playwright.dev)**: End-to-end testing framework
+- **[TypeScript](https://www.typescriptlang.org/)**: Type-safe JavaScript
+
+## 🛠️ Customization
+
+### Configuration
+
+The main configuration files are located in the `src` directory:
+
+- `config.ts`: General site configuration (title, theme, navigation, etc.)
+- `content.config.ts`: Notion integration configuration
+
+### Notion Database Setup
+
+Your Notion database should include the following properties for optimal compatibility:
+
+- `title` (Title): The title of your post
+- `date` (Date): Publication date
+- `status` (Select): Publication status (e.g., "Published", "Draft")
+- `tags` (Multi-select): Post tags
+- `category` (Select): Post category
+- `description` (Text): Brief description for SEO and previews
+- `image` (URL or Files & Media): Cover image
+
+### Theme Customization
+
+Edit the `src/config.ts` file to customize:
+
+- Site title and subtitle
+- Theme colors and appearance
+- Navigation links
+- Profile information
+- Banner images
+- License information
+
+## 🚀 Advanced Features
+
+### URL Migration
+
+This template includes tools for migrating from other blog platforms by setting up URL redirects. The migration system works as follows:
+
+1. Define your URL mappings in `migration/url-map.json`
+2. The format is `{"new-url": ["old-url-1", "old-url-2", ...]}`
+3. The system automatically creates redirects from all old URLs to the new URL
+4. E2E tests in `tests/e2e/url-redirects.spec.ts` verify that redirects work correctly
+
+Example URL mapping:
+
+```json
+{
+  "my-new-post": ["2023/01/01/old-post", "post/category/old-post", "/old-post", "/blog/old-post"]
+}
+```
+
+### Testing
+
+The project includes Playwright tests to verify URL redirects and other functionality:
+
+```bash
+pnpm test:e2e
 ```
 
 ## 🧞 Commands
 
-All commands are run from the root of the project, from a terminal:
+All commands are run from the root of the project:
 
 | Command                             | Action                                           |
-|:------------------------------------|:-------------------------------------------------|
+| :---------------------------------- | :----------------------------------------------- |
 | `pnpm install` AND `pnpm add sharp` | Installs dependencies                            |
 | `pnpm dev`                          | Starts local dev server at `localhost:4321`      |
 | `pnpm build`                        | Build your production site to `./dist/`          |
 | `pnpm preview`                      | Preview your build locally, before deploying     |
-| `pnpm new-post <filename>`          | Create a new post                                |
+| `pnpm test:e2e`                     | Run Playwright E2E tests                         |
+| `pnpm lint`                         | Run ESLint to check code quality                 |
+| `pnpm format`                       | Format code with Prettier                        |
 | `pnpm astro ...`                    | Run CLI commands like `astro add`, `astro check` |
 | `pnpm astro --help`                 | Get help using the Astro CLI                     |