Ruanyf Weekly

Overview:

The ruanyf-weekly is an unofficial platform that provides a centralized and user-friendly reading entry point for Ruanyifeng’s technical weekly newsletter. It addresses the lack of a unified cross-platform reading experience and search capabilities. Built using Ruanyifeng’s open-source content, the platform utilizes existing tools to create a static website and automate deployment with CI while enhancing text search capabilities.

Features:

• Mobile QR Code Entry: Added a QR code entry for mobile reading (credit: @terminalqo).
• Bug Fixes: Removed ineffective push triggers from GitHub Action.
• Discord Integration: Added Discord feature.
• One-Click Deployment: Easily deploy to Vercel platform (credit: @chaos-zhu) along with a donation option for free lunch.
• Weekly Updates: Weekly updates scheduled on Fridays. Giscus integrated with dark mode and route-following updates.
• NavBar Enhancement: Added weekly report title to the navigation bar.
• VitePress Website: Built static pages using VitePress, deployed on Vercel. Integrated Algolia for search capabilities. GitHub Action for weekly builds. Giscus for comments and donation option for free lunch.

Installation:

1. Local Installation:
   • Install dependencies: npm i
   • Crawl newsletter: ./script/main.sh
   • Start: npm run docs:dev
2. Vercel Deployment:
   • Deploy to Vercel directly.

Summary:

The ruanyf-weekly platform offers a solution for readers of Ruanyifeng’s technical weekly newsletter by providing a unified and accessible reading experience with enhanced search functionalities. Through integrating various features like weekly updates, Discord integration, and one-click deployment, the platform enhances the overall user experience. Additionally, the engagement options like comments through Giscus and donation feature add to the community-building aspect of the platform.