Farrow Documentation Site

A comprehensive, bilingual documentation site for Farrow - A progressive TypeScript web framework.

🌟 Features

• 📚 Bilingual Support: Full documentation in both Chinese and English
• 🎨 Modern Design: Clean, responsive layout built with VitePress
• 🔍 Full-text Search: Fast local search functionality
• 📱 Mobile Friendly: Optimized for all device sizes
• 🌙 Dark Mode: Automatic theme switching support
• ⚡ Fast Performance: Static site generation for optimal loading speed

🚀 Quick Start

Prerequisites

• Node.js >= 18.0.0
• pnpm >= 8.0.0

Installation

# Clone the repository
git clone https://github.com/AisonSu/farrow-doc.git
cd farrow-doc

# Install dependencies
pnpm install

# Start development server
pnpm dev

Visit http://localhost:5173 to see the documentation site.

📝 Available Scripts

# Development server
pnpm dev

# Build for production
pnpm build

# Preview production build
pnpm preview

# Interactive commit (Commitizen)
pnpm commit

📂 Project Structure

farrow-vitepress/
├── .vitepress/           # VitePress configuration
│   └── config.mts        # Site configuration
├── guide/                # Guide documentation (Chinese)
│   ├── essentials.md
│   ├── advanced.md
│   └── philosophy-and-practices.md
├── api/                  # API reference (Chinese)
│   ├── farrow-http.md
│   ├── farrow-schema.md
│   └── farrow-pipeline.md
├── ecosystem/            # Ecosystem packages (Chinese)
├── en/                   # English documentation
│   ├── guide/           # English guide
│   ├── api/             # English API reference
│   └── ecosystem/       # English ecosystem docs
├── public/              # Static assets
└── package.json         # Project configuration

🌐 Deployment

Vercel (Recommended)

Netlify

Manual Deployment

1. Build the site:

   pnpm build

2. Deploy the .vitepress/dist directory to your hosting provider.

GitHub Pages

The repository includes a GitHub Actions workflow for automatic deployment to GitHub Pages. Simply push to the main branch to trigger a deployment.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes using Commitizen (pnpm commit)
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📄 License

This documentation site is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Farrow - The framework being documented
• VitePress - The documentation site generator
• All contributors who have helped improve this documentation

📧 Contact

• Author: Aison
• Email: aisonsu@outlook.com
• GitHub: @AisonSu