https://github.com/plantree/ruanyf-weekly

VitePress构建阮一峰的技术周刊
https://github.com/plantree/ruanyf-weekly

algolia blog technology

Last synced: 2 days ago
JSON representation

VitePress构建阮一峰的技术周刊

• Host: GitHub
• URL: https://github.com/plantree/ruanyf-weekly
• Owner: plantree
• License: mit
• Created: 2023-03-06T01:18:22.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-25T01:54:10.000Z (16 days ago)
• Last Synced: 2024-10-26T12:38:17.609Z (15 days ago)
• Topics: algolia, blog, technology
• Language: JavaScript
• Homepage: https://ruanyf-weekly.plantree.me/
• Size: 410 KB
• Stars: 286
• Watchers: 2
• Forks: 37
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - plantree/ruanyf-weekly - VitePress构建阮一峰的技术周刊 (JavaScript)

README

        
# ruanyf-weekly











> 声明: 非官方！！！官网链接在https://www.ruanyifeng.com/blog/

网站地址在：https://ruanyf-weekly.plantree.me/

#### 一. 背景

个人平时比较喜欢看阮一峰老师的技术周刊，文笔简练，条理清晰。

但也遇到了一些问题：

- 缺少一个跨端且友好的统一阅读入口

- 检索能力较欠缺

#### 二. 构建

因为阮一峰老师的技术周刊本身是开源的，因此可基于这些内容，利用现成的工具，重新构建一个静态网站，并借助CI实现部署自动化，同时对文本增加检索能力。

- 页面构建采用了VitePress

- 网站部署在Vercel

- 定时构建采用了GitHub Action

- 搜索引擎使用Algolia

#### 三. 本地启动

- 安装依赖：`npm i`

- 爬取周刊：`./script/main.sh`

- 启动：`npm run docs:dev`

#### 四. Vercel部署

[![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fplantree%2Fruanyf-weekly&install-command=npm%20install&build-command=bash%20.%2Fscripts%2Fmain.sh%20%26%26%20npm%20run%20docs%3Abuild&output-directory=docs%2F.vitepress%2Fdist)

#### Changelog

##### 2023.05.15

###### Features

- 增加移动端阅读二维码入口(感谢@[terminalqo](https://github.com/terminalqo))

##### 2023.04.12

###### Bug Fixes

- 去除GitHub Action无效的push触发

###### Features

- 增加discord

##### 2023.04.10

###### Features

- 一键部署到Vercel（感谢@[chaos-zhu](https://github.com/chaos-zhu))

- 增加公益捐赠（免费午餐）

##### 2023.03.27

###### Bug Fixes

- 定期更新时间改为周五

- Giscus适配dark-mode

- Giscus跟随路由跳转而更新

###### Features

- NavBar增加周报title

##### 2023.03.23

###### Features

- VitePress构建静态页面，并部署到Vercel

- 接入Algolia

- GitHub Action周级构建

- 接入Giscus，增加评论

#### 公益捐赠（免费午餐）











#### 参考

1. https://www.ruanyifeng.com/blog/

1. https://giscus.app/zh-CN

1. http://www.mianfeiwucan.org/