docs: make Chinese README the default
This commit is contained in:
@@ -1,3 +1,9 @@
|
||||
<!-- WEHUB_ZH_README -->
|
||||
> [!NOTE]
|
||||
> 本文档由 WeHub 基于上游 README 翻译整理,属于社区翻译,非官方中文文档。
|
||||
> [English](./README.en.md) · [原始项目](https://github.com/nexmoe/VidBee) · [上游 README](https://github.com/nexmoe/VidBee/blob/HEAD/README.md)
|
||||
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
|
||||
|
||||
<div align="left">
|
||||
<a href="https://github.com/nexmoe/VidBee">
|
||||
<img src="apps/desktop/build/icon.png" alt="Logo" width="80" height="80">
|
||||
@@ -20,76 +26,76 @@
|
||||
</p>
|
||||
</div>
|
||||
|
||||
VidBee is a modern, open-source video downloader that lets you download videos and audios from 1000+ websites worldwide. Built with Electron and powered by yt-dlp, VidBee offers a clean, intuitive interface with powerful features for all your downloading needs, including RSS auto-download automation that automatically subscribes to feeds and downloads new videos from your favorite creators in the background.
|
||||
VidBee 是一款现代化的开源视频下载器,可让你从全球 1000+ 个网站下载视频和音频。基于 Electron 构建,并由 yt-dlp 驱动,VidBee 提供简洁直观的界面以及强大的下载功能,满足你的各类下载需求,包括 RSS 自动下载自动化——可自动订阅订阅源,并在后台从你喜爱的创作者处下载新视频。
|
||||
|
||||
## 👋🏻 Getting Started
|
||||
## 👋🏻 入门指南
|
||||
|
||||
VidBee is currently under active development, and feedback is welcome for any [issue](https://github.com/nexmoe/VidBee/issues) encountered.
|
||||
VidBee 目前仍在积极开发中,欢迎就遇到的任何 [issue](https://github.com/nexmoe/VidBee/issues) 提供反馈。
|
||||
|
||||
[📥 Download VidBee](https://vidbee.org/download/) | [📚 Documentation](https://docs.vidbee.org)
|
||||
[📥 下载 VidBee](https://vidbee.org/download/) | [📚 文档](https://docs.vidbee.org)
|
||||
|
||||
> [!IMPORTANT]
|
||||
>
|
||||
> **Star Us**, You will receive all release notifications from GitHub without any delay ~
|
||||
> **为我们点 Star**,你将第一时间收到 GitHub 上的所有版本发布通知 ~
|
||||
|
||||
<a href="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats?repo_id=1081230042" target="_blank" style="display: block" align="left">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats/thumbnail.png?repo_id=1081230042&image_size=auto&color_scheme=dark" width="655" height="auto">
|
||||
<img alt="Performance Stats of nexmoe/VidBee - Last 28 days" src="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats/thumbnail.png?repo_id=1081230042&image_size=auto&color_scheme=light" width="655" height="auto">
|
||||
<img alt="nexmoe/VidBee 性能统计 - 最近 28 天" src="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats/thumbnail.png?repo_id=1081230042&image_size=auto&color_scheme=light" width="655" height="auto">
|
||||
</picture>
|
||||
</a>
|
||||
|
||||
<!-- Made with [OSS Insight](https://ossinsight.io/) -->
|
||||
|
||||
## ✨ Features
|
||||
## ✨ 功能特性
|
||||
|
||||
### 🌍 Global Video Download Support
|
||||
### 🌍 全球视频下载支持
|
||||
|
||||
Download videos from almost any website worldwide through the powerful yt-dlp engine. Support for 1000+ sites including YouTube, TikTok, Instagram, Twitter, and many more.
|
||||
通过强大的 yt-dlp 引擎,从全球几乎任何网站下载视频。支持 1000+ 个站点,包括 YouTube、TikTok、Instagram、Twitter 等。
|
||||
|
||||

|
||||

|
||||
|
||||
### 🎨 Best-in-class UI Experience
|
||||
### 🎨 一流的 UI 体验
|
||||
|
||||
Modern, clean interface with intuitive operations. One-click pause/resume/retry, real-time progress tracking, and comprehensive download queue management.
|
||||
现代化、简洁的界面,操作直观。支持一键暂停/恢复/重试、实时进度跟踪,以及完善的下载队列管理。
|
||||
|
||||

|
||||

|
||||
|
||||
### 📡 RSS Auto Download
|
||||
### 📡 RSS 自动下载
|
||||
|
||||
Automatically subscribe to RSS feeds and auto-download new videos in the background from your favorite creators across YouTube, TikTok, and more. Set up RSS subscriptions once, and VidBee will automatically download new uploads without manual intervention, perfect for keeping up with your favorite channels and creators.
|
||||
自动订阅 RSS 订阅源,并在后台从你喜爱的创作者处自动下载新视频,覆盖 YouTube、TikTok 等平台。只需配置一次 RSS 订阅,VidBee 便会自动下载新上传内容,无需手动操作,非常适合持续关注你喜爱的频道和创作者。
|
||||
|
||||
### 🎞️ Configurable Output Containers
|
||||
### 🎞️ 可配置的输出容器
|
||||
|
||||
Pick between **Auto (MP4/MKV)**, **MP4**, **MKV**, **WebM**, or yt-dlp's **Original** defaults for one-click downloads — no more wondering whether you'll get an MP4 or a WebM. See [Formats & Containers](https://docs.vidbee.org/formats) for the full breakdown.
|
||||
可在 **Auto (MP4/MKV)**、**MP4**、**MKV**、**WebM** 或 yt-dlp 的 **Original** 默认选项之间选择,实现一键下载——再也不用纠结最终会拿到 MP4 还是 WebM。完整说明见 [Formats & Containers](https://docs.vidbee.org/formats)。
|
||||
|
||||
## 🌐 Supported Sites
|
||||
## 🌐 支持的网站
|
||||
|
||||
VidBee supports 1000+ video and audio platforms through yt-dlp. For the complete list of supported sites, visit [https://vidbee.org/supported-sites/](https://vidbee.org/supported-sites/)
|
||||
VidBee 通过 yt-dlp 支持 1000+ 个视频和音频平台。完整支持列表请访问 [https://vidbee.org/supported-sites/](https://vidbee.org/supported-sites/)
|
||||
|
||||
## 🧱 Web + API (Docker-ready)
|
||||
## 🧱 Web + API(支持 Docker)
|
||||
|
||||
This monorepo now includes:
|
||||
此 monorepo 现已包含:
|
||||
|
||||
- `packages/downloader-core`: Shared yt-dlp/ffmpeg download core
|
||||
- `apps/api`: Fastify API server with oRPC and SSE events
|
||||
- `apps/web`: TanStack Start web client using oRPC
|
||||
- `packages/downloader-core`:共享的 yt-dlp/ffmpeg 下载核心
|
||||
- `apps/api`:基于 Fastify 的 API 服务器,支持 oRPC 与 SSE 事件
|
||||
- `apps/web`:使用 oRPC 的 TanStack Start Web 客户端
|
||||
|
||||
Run locally:
|
||||
本地运行:
|
||||
|
||||
```bash
|
||||
pnpm run start:web
|
||||
```
|
||||
|
||||
This command starts `apps/api` and `apps/web` together.
|
||||
该命令会同时启动 `apps/api` 和 `apps/web`。
|
||||
|
||||
Run with Docker:
|
||||
使用 Docker 运行:
|
||||
|
||||
```bash
|
||||
docker compose up -d --build
|
||||
```
|
||||
|
||||
Run with GitHub Container Registry images:
|
||||
使用 GitHub Container Registry 镜像运行:
|
||||
|
||||
```yaml
|
||||
services:
|
||||
@@ -120,13 +126,13 @@ volumes:
|
||||
vidbee-data:
|
||||
```
|
||||
|
||||
Stop services:
|
||||
停止服务:
|
||||
|
||||
```bash
|
||||
docker compose down
|
||||
```
|
||||
|
||||
Optional env vars (via `.env`):
|
||||
可选环境变量(通过 `.env`):
|
||||
|
||||
```bash
|
||||
VIDBEE_API_PORT=3100
|
||||
@@ -134,28 +140,28 @@ VIDBEE_WEB_PORT=3000
|
||||
VITE_API_URL=http://localhost:3100
|
||||
```
|
||||
|
||||
## 🤝 Contributing
|
||||
## 🤝 参与贡献
|
||||
|
||||
You are welcome to join the open source community to build together. For more details, check out:
|
||||
欢迎加入开源社区,一起共建。更多详情请查看:
|
||||
|
||||
- Monorepo apps:
|
||||
- `apps/desktop`: VidBee desktop app (Electron)
|
||||
- `apps/docs`: Documentation site (Fumapress)
|
||||
- `apps/extension`: Browser extension (WXT)
|
||||
- `apps/desktop/docs/glitchtip.md`: GlitchTip and `sentry-cli` setup for desktop monitoring
|
||||
- [Contributing Guide](./CONTRIBUTING.md)
|
||||
- Monorepo 应用:
|
||||
- `apps/desktop`:VidBee 桌面应用(Electron)
|
||||
- `apps/docs`:文档站点(Fumapress)
|
||||
- `apps/extension`:浏览器扩展(WXT)
|
||||
- `apps/desktop/docs/glitchtip.md`:GlitchTip 与 `sentry-cli` 的桌面监控配置
|
||||
- [贡献指南](./CONTRIBUTING.md)
|
||||
- [DeepWiki Documentation](https://deepwiki.com/nexmoe/VidBee)
|
||||
|
||||
## 📄 License
|
||||
## 📄 许可证
|
||||
|
||||
This project is distributed under the MIT License. See [`LICENSE`](LICENSE) for details.
|
||||
本项目基于 MIT License 发布。详情请参阅 [`LICENSE`](LICENSE)。
|
||||
|
||||
## 🙏 Thanks
|
||||
## 🙏 致谢
|
||||
|
||||
- [yt-dlp](https://github.com/yt-dlp/yt-dlp) - The powerful video downloader engine
|
||||
- [FFmpeg](https://ffmpeg.org/) - The multimedia framework for video and audio processing
|
||||
- [Electron](https://www.electronjs.org/) - Build cross-platform desktop apps
|
||||
- [React](https://react.dev/) - The UI library
|
||||
- [Vite](https://vitejs.dev/) - Next generation frontend tooling
|
||||
- [Tailwind CSS](https://tailwindcss.com/) - Utility-first CSS framework
|
||||
- [shadcn/ui](https://ui.shadcn.com/) - Beautifully designed components
|
||||
- [yt-dlp](https://github.com/yt-dlp/yt-dlp) - 强大的视频下载引擎
|
||||
- [FFmpeg](https://ffmpeg.org/) - 用于音视频处理的多媒体框架
|
||||
- [Electron](https://www.electronjs.org/) - 构建跨平台桌面应用
|
||||
- [React](https://react.dev/) - UI 库
|
||||
- [Vite](https://vitejs.dev/) - 下一代前端工具链
|
||||
- [Tailwind CSS](https://tailwindcss.com/) - 实用优先的 CSS 框架
|
||||
- [shadcn/ui](https://ui.shadcn.com/) - 精心设计的组件
|
||||
|
||||
Reference in New Issue
Block a user