Skip to content

Commit 39e320d

Browse files
docs: rewrite README with product-focused intro
将 README 从纯文档仓说明改写为 Mp2RSS 产品介绍, 突出产品主站、特性与文档导航,原有的本地开发与目录结构说明下沉为次要章节。
1 parent f6659ba commit 39e320d

1 file changed

Lines changed: 47 additions & 6 deletions

File tree

README.md

Lines changed: 47 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,48 @@
1-
# Mp2RSS Docs
1+
# Mp2RSS
22

3-
Mp2RSS 产品介绍与 Open API 文档站点,基于 [VitePress](https://vitepress.dev/) 构建
3+
把微信公众号转成标准 Feed 的订阅服务 —— 在 Reeder、NetNewsWire、FreshRSS、Miniflux 等任意阅读器里,像订阅播客一样订阅公众号
44

5-
## 本地开发
5+
- 🌐 产品主站:<https://mp2rss.bugcode.dev>
6+
- 📖 使用文档:<https://areyoubugcoder.github.io/Mp2RSS/>
7+
8+
## 特性
9+
10+
- 🪶 **无需微信账号** —— GitHub / Google OAuth 登录即可使用
11+
- 📡 **主流格式全覆盖** —— RSS 2.0 / Atom 1.0 / JSON Feed 1.1 / OPML 2.0
12+
- 🗂️ **单号 + 合集双形态** —— 按公众号订阅,或聚合成一个 Feed
13+
- 🔁 **一处订阅,多端同步** —— 同一条链接粘贴到任意阅读器
14+
- 🎁 **3 天免费试用** —— 试用期权益与正式会员完全相同
15+
- 🤖 **API 友好** —— 搜索、订阅、拉文章均可脚本化
16+
17+
## 快速开始
18+
19+
1. 打开 <https://mp2rss.bugcode.dev>,用 GitHub / Google 登录;
20+
2. 在订阅管理页贴入任意一篇公众号文章 URL 完成订阅;
21+
3. 在账户设置页复制 Feed 链接,粘贴到你的阅读器即可持续收到更新。
22+
23+
详细步骤见 [快速开始](https://areyoubugcoder.github.io/Mp2RSS/guide/quick-start)
24+
25+
## 文档导航
26+
27+
- [服务介绍](https://areyoubugcoder.github.io/Mp2RSS/guide/intro)
28+
- [订阅管理](https://areyoubugcoder.github.io/Mp2RSS/guide/subscription)
29+
- [会员与计费](https://areyoubugcoder.github.io/Mp2RSS/guide/membership)
30+
- [Open API 列表](https://areyoubugcoder.github.io/Mp2RSS/api/)
31+
- [FAQ](https://areyoubugcoder.github.io/Mp2RSS/guide/faq)
32+
- [服务条款](https://areyoubugcoder.github.io/Mp2RSS/guide/terms-of-service)
33+
34+
## 反馈与交流
35+
36+
- Bug / 功能建议:[Issues](https://github.com/areyoubugcoder/Mp2RSS/issues)
37+
- 使用讨论:[Discussions](https://github.com/areyoubugcoder/Mp2RSS/discussions)
38+
39+
---
40+
41+
## 本仓库说明
42+
43+
本仓库托管 Mp2RSS 的产品介绍与 Open API 文档站点,基于 [VitePress](https://vitepress.dev/) 构建,推送到 `main` 后由 GitHub Actions 自动部署到 GitHub Pages。
44+
45+
### 本地开发
646

747
```bash
848
pnpm install
@@ -11,13 +51,14 @@ pnpm build # 产物输出到 .vitepress/dist
1151
pnpm preview # 本地预览生产构建
1252
```
1353

14-
## 目录
54+
### 目录结构
1555

1656
- `docs/` —— 站点内容源文件
1757
- `index.md` —— 首页
1858
- `guide/` —— 使用指南
1959
- `api/` —— Open API 参考
2060
- `public/` —— 静态资源(favicon / logo)
2161
- `.vitepress/` —— VitePress 配置与主题定制
22-
- `config.mts` —— 站点配置(nav / sidebar / search)
23-
- `theme/` —— 主题增强(`CopyPath` 组件、自定义样式)
62+
- `config.mts` —— 站点配置
63+
- `theme/` —— 主题增强(`CopyPath` 组件等)
64+
- `.github/workflows/deploy.yml` —— Pages 部署工作流

0 commit comments

Comments
 (0)