🔨remove header index

zhEdward · Feb 23, 2023 · f6760f4 · f6760f4
1 parent 7d89ece
commit f6760f4
Show file tree

Hide file tree

Showing 129 changed files with 169 additions and 1,054 deletions.
diff --git a/.vuepress/config.js b/.vuepress/config.js
@@ -16,6 +16,13 @@ module.exports = {
             {text: '首页', link: '/'},
             {text: '目录', link: '/#🍴目录'},
             {text: '贡献指南', link: '/CONTRIBUTING.html'},
+            {
+                text: '相关社群',
+                items: [
+                    {text: 'QQ交流群', link: 'https://jq.qq.com/?_wv=1027&k=s1M0LCcu'},
+                    {text: 'Telegram交流群', link: 'https://t.me/bilibili_API_collect_community'}
+                ]
+            },
             {text: 'GitHub', link: '/~https://github.com/SocialSisterYi/bilibili-API-collect'},
         ],
         sidebar: 'auto',

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -14,11 +14,18 @@
 
 ### 目录
 
-文档目录以 **列表** 语法写在 [README.md](README.md) 中，使用缩进标识文档的层级，如`视频`下存在`基本信息`、`快照`、`推荐`等子分类
+文档目录以 **Markdown无序列表** 语法写在 [README.md](README.md) 中，使用缩进标识文档的层级，如`视频`下存在`基本信息`、`快照`、`推荐`等子分类，使用 **Markdown 复选框** 语法该标注文档是否编写完成
+
+```markdown
+- [x] 视频
+  - [x] 基本信息
+  - [x] 快照
+  - [x] 推荐
+```
 
 ### 路径
 
-路径层级应当与文档目录一致，以文件夹的形式存放在项目中，命名统一使用英文，如`video`、`danmaku`、`comment`
+路径层级应当与文档目录一致，以文件夹的形式存放在项目中的`/docs`路径下，命名统一使用英文，如`video`、`danmaku`、`comment`
 
 二级、三级路径应当存在二级三级目录，以`README.md`的形式
 
@@ -28,26 +35,17 @@
 
 文档文件中用于存放相关的接口的说明，如`video/`下的`info.md`，存在`查询视频基本信息`、`查询视频简介`、`查询视频分P列表`等内容
 
-## 文档内容格式
+## Markdown文档内容格式
+
+文档使用 [Vuepress](https://vuepress.vuejs.org/) 生成，可以使用 [Vuepress md 扩展语法](https://vuepress.vuejs.org/guide/markdown.html)编写
 
 注：以下文档范式可根据**实际情况**进行调整
 
 ### 头部
 
 文档首行为 **一级标签** 格式标题
 
-标题下方为索引，与正文二级标题对应，使用 **列表** 语法与缩进，每项使用 **超链接** 语法实现 id 锚点跳转
-
-头部结束应使用 **分隔线** 语法划线分割
-
-```markdown
-# 视频
-
-- [获取视频详细信息](#获取视频详细信息)
-- [获取视频简介](#获取视频简介)
-
----
-```
+**文档头部不再需要手写索引**
 
 ### 接口说明
 
@@ -187,6 +185,32 @@ eg：
 | 74   | 720P60 高帧率 | 登录认证                                                     |
 | 80   | 1080P 高清    | TV 端与 APP 端默认值<br />登录认证                           |
 
+## Proto定义格式
+
+proto 文件为 [Protocol Buffers](https://protobuf.dev/) 以及 [gRPC](https://grpc.io/docs/) 的数据结构体定义，多用于客户端的接口，本文档也做相关的收集
+
+存放于项目的`/grpc_api`路径下，使用包名进行路径层级的组织，如
+
+```
+/grpc_api/bilibili/main/community/reply/v1/reply.proto
+/grpc_api/bilibili/app/archive/v1/archive.proto
+/grpc_api/bilibili/app/view/v1/view.proto
+```
+
+proto 文件内使用 **单行注释** 标注字段或对象的含义，如
+
+```protobuf
+// UP主信息
+message Author {
+	// UP主mid
+	int64 mid = 1;
+	// UP主昵称
+	string name = 2;
+	// UP主头像url
+	string face = 3;
+}
+```
+
 ## 文档提交
 
 TODO

diff --git a/README.md b/README.md
@@ -128,7 +128,7 @@ B站 API 采用 C/S 结构，大多数接口为 REST API 和 gRPC，少部分接
 - [ ] [专栏](docs/article)
   - [ ] 分区
   - [X] [基本信息](docs/article/info.md)
-  - [X] [点赞 & 投币 & 收藏 & 分享](docs/article/like_coin_fav.md)
+  - [X] [点赞 & 投币 & 收藏 & 分享](docs/article/action.md)
   - [X] [文集基本信息](docs/article/articles.md)
   - [X] [获取用户专栏文章列表](docs/article/list.md)
 - [ ] [音频](docs/audio)
@@ -138,10 +138,11 @@ B站 API 采用 C/S 结构，大多数接口为 REST API 和 gRPC，少部分接
   - [ ] [投币 & 收藏](docs/audio/action.md)
   - [x] [播放 & 下载地址（音频流）](docs/audio/musicstream_url.md)
   - [ ] 音频榜单
-- [ ] [排行榜 & 最新视频](docs/ranking&dynamic)
-  - [ ] [排行榜](docs/ranking&dynamic/ranking.md)
-  - [ ] [热门视频](docs/ranking&dynamic/popular.md)
-  - [ ] [最新视频](docs/ranking&dynamic/dynamic.md)
+- [ ] [排行榜 & 最新视频](docs/video_ranking)
+  - [ ] [排行榜](docs/video_ranking/ranking.md)
+  - [ ] [热门视频](docs/video_ranking/popular.md)
+  - [ ] [最新视频](docs/video_ranking/dynamic.md)
+  - [x] [入站必刷视频](docs/video_ranking/precious_videos.md)
 - [ ] [搜索](docs/search)
   - [x] [搜索请求](docs/search/search_request.md)
   - [x] [搜索结果](docs/search/search_response.md)
@@ -207,6 +208,7 @@ B站 API 采用 C/S 结构，大多数接口为 REST API 和 gRPC，少部分接
   - [ ] [直播视频流](docs/live/live_stream.md)
   - [ ] [直播信息流](docs/live/message_stream.md)
   - [ ] [直播红包](docs/live/redpocket.md)
+  - [ ] [直播间用户实用 API](docs/live/user.md)
 - [ ] [转正答题](docs/newbie_exam)
   - [x] [查询信息](docs/newbie_exam/info.md)
   - [x] [拉取题目](docs/newbie_exam/fetch.md)
@@ -216,6 +218,7 @@ B站 API 采用 C/S 结构，大多数接口为 REST API 和 gRPC，少部分接
   - [ ] B币充值
   - [ ] 贝壳相关
 - [ ] [哔哩哔哩漫画](docs/manga)
+  - [ ] [用户信息](docs/manga/user.md)
   - [x] [签到](docs/manga/ClockIn.md)
   - [x] [积分商城](docs/manga/point_shop.md)
   - [x] [漫画操作](docs/manga/Comic.md)

diff --git a/docs/APP_widget/splash.md b/docs/APP_widget/splash.md
@@ -1,10 +1,5 @@
 # APP端开屏图片
 
-- [获取APP端开屏图片列表](#获取APP端开屏图片列表)
-- [获取APP端开屏幕广告信息](#获取APP端开屏幕广告信息)
-
----
-
 ## 获取APP端开屏图片列表
 
 > https://app.bilibili.com/x/v2/splash/brand/list

diff --git a/docs/album/action.md b/docs/album/action.md
@@ -1,11 +1,5 @@
 # 相簿操作
 
-- [~~点赞相簿~~](#~~点赞相簿~~)
-- [~~收藏相簿~~](#~~收藏相簿~~)
-- [取消收藏相簿](#取消收藏相簿)
-
----
-
 ## ~~点赞相簿~~
 
 > https://api.vc.bilibili.com/link_draw/v2/Vote/operate

diff --git a/docs/album/activity_list.md b/docs/album/activity_list.md
@@ -1,9 +1,5 @@
 # 相簿活动列表
 
-- [获取相簿热门活动列表](#获取相簿热门活动列表)
-
----
-
 ## 获取相簿热门活动列表
 
 > https://api.vc.bilibili.com/photo_activity/v2/Activity/list

diff --git a/docs/album/info.md b/docs/album/info.md
@@ -1,9 +1,5 @@
 # 相簿基本信息
 
-- [获取相簿详细信息](#获取相簿详细信息)
-
----
-
 ## 获取相簿详细信息
 
 >https://api.vc.bilibili.com/link_draw/v1/doc/detail

diff --git a/docs/album/list.md b/docs/album/list.md
@@ -1,13 +1,5 @@
 # 相簿列表
 
-- [获取画友首页列表](#获取画友首页列表)
-- [获取摄影首页列表](#获取摄影首页列表)
-- [获取画友列表](#获取画友列表)
-- [获取摄影列表](#获取摄影列表)
-- [获取指定用户的相簿列表](#获取指定用户的相簿列表)
-
----
-
 ## 获取画友首页列表
 
 > https://api.vc.bilibili.com/link_draw/v2/Doc/index

diff --git a/docs/album/recommend_author.md b/docs/album/recommend_author.md
@@ -1,10 +1,5 @@
 # 相簿推荐作者
 
-- [获取摄影推荐作者](#获取摄影推荐作者)
-- [获取画友推荐作者](#获取画友推荐作者)
-
----
-
 ## 获取摄影推荐作者
 
 > https://api.vc.bilibili.com/link_draw/v2/Photo/uper

diff --git a/docs/article/like_coin_fav.md → docs/article/action.md b/docs/article/like_coin_fav.md → docs/article/action.md
@@ -1,11 +1,5 @@
 # 专栏投币&点赞&收藏
 
-- [点赞文章](#点赞文章)
-- [投币文章](#投币文章)
-- [收藏文章](#收藏文章)
-
----
-
 ## 点赞文章
 
 <img src="../../assets/img/like.svg" width="100" height="100"/>

diff --git a/docs/article/articles.md b/docs/article/articles.md
@@ -1,9 +1,5 @@
 # 文集基本信息
 
-- [获取文集基本信息](#获取文集基本信息)
-
----
-
 ## 获取文集基本信息
 
 > https://api.bilibili.com/x/article/list/web/articles

diff --git a/docs/article/info.md b/docs/article/info.md
@@ -1,9 +1,5 @@
 # 专栏基本信息
 
-- [获取专栏文章基本信息](#获取专栏文章基本信息)
-
----
-
 ## 获取专栏文章基本信息
 
 > https://api.bilibili.com/x/article/viewinfo

diff --git a/docs/article/list.md b/docs/article/list.md
@@ -1,10 +1,5 @@
 # 获取用户专栏信息
 
-- [获取用户专栏文章列表](#获取用户专栏文章列表)
-- [获取用户专栏文集列表](#获取用户专栏文集列表)
-
----
-
 ## 获取用户专栏文章列表
 
 > https://api.bilibili.com/x/space/article

diff --git a/docs/audio/action.md b/docs/audio/action.md
@@ -1,11 +1,5 @@
 # 音频投币&收藏
 
-- [查询音频收藏状态](#查询音频收藏状态)
-- [查询音频投币数](#查询音频投币数)
-- [投币音频](#投币音频)
-
----
-
 ## 查询音频收藏状态
 
 > https://www.bilibili.com/audio/music-service-c/web/collections/songs-coll

diff --git a/docs/audio/info.md b/docs/audio/info.md
@@ -1,12 +1,5 @@
 # 歌曲基本信息
 
-- [查询歌曲基本信息](#查询歌曲基本信息)
-- [查询歌曲TAG](#查询歌曲TAG)
-- [查询歌曲创作成员列表](#查询歌曲创作成员列表)
-- [获取歌曲歌词](#获取歌曲歌词)
-
----
-
 ## 查询歌曲基本信息
 
 > https://www.bilibili.com/audio/music-service-c/web/song/info

diff --git a/docs/audio/music_list.md b/docs/audio/music_list.md
@@ -1,13 +1,5 @@
 # 歌单&音频收藏夹详细信息
 
-- [歌单&音频收藏夹详细信息](#歌单音频收藏夹详细信息)
-  - [查询自己创建的歌单](#查询自己创建的歌单)
-  - [查询音频收藏夹（默认歌单）信息](#查询音频收藏夹默认歌单信息)
-  - [查询热门歌单](#查询热门歌单)
-  - [查询热门榜单](#查询热门榜单)
-
----
-
 ## 查询自己创建的歌单
 
 > https://www.bilibili.com/audio/music-service-c/web/collections/list

diff --git a/docs/audio/musicstream_url.md b/docs/audio/musicstream_url.md
@@ -2,11 +2,7 @@
 
 <img src="../../assets/img/download.svg" width="100" height="100"/>
 
-- [获取音频流URL（无法获取付费音频）（web端）](#获取音频流url无法获取付费音频web端)
-- [获取音频流URL（可获取付费音频）（双端）](#获取音频流url可获取付费音频双端)
-- [音频流的获取](#音频流的获取)
-
----
+## 音质qn参数定义
 
 音质`qn`参数：
 
@@ -17,7 +13,7 @@
 | 2    | 高品质 320K          |
 | 3    | 无损 FLAC （大会员） |
 
-## 获取音频流URL（无法获取付费音频）（web端）
+## 获取音频流URL(web端)
 
 > https://www.bilibili.com/audio/music-service-c/web/url
 
@@ -98,7 +94,7 @@ curl -G 'https://www.bilibili.com/audio/music-service-c/web/url' \
 
 </details>
 
-## 获取音频流URL（可获取付费音频）（双端）
+## 获取音频流URL（可获取付费音频）
 
 > https://api.bilibili.com/audio/music-service-c/url
 

diff --git a/docs/audio/status_number.md b/docs/audio/status_number.md
@@ -1,9 +1,5 @@
 # 音频状态数
 
-- [歌曲状态数](#歌曲状态数)
-
----
-
 ## 歌曲状态数
 
 >https://www.bilibili.com/audio/music-service-c/web/stat/song

diff --git a/docs/bangumi/follow.md b/docs/bangumi/follow.md
@@ -1,10 +1,5 @@
 # 追番相关
 
-- [追番](#追番)
-- [取消追番](#取消追番)
-
----
-
 ## 追番
 > https://api.bilibili.com/pgc/web/follow/add
 

diff --git a/docs/bangumi/info.md b/docs/bangumi/info.md
@@ -1,14 +1,7 @@
 # 剧集基本信息
 
-- [剧集基本信息（mdid方式）](#剧集基本信息mdid方式)
-- [获取剧集明细（web端）（ssid/epid方式）](#获取剧集明细web端ssidepid方式)
-- [获取剧集分集信息](#获取剧集分集信息)
-
----
-
 ## 剧集基本信息（mdid方式）
 
-
 > https://api.bilibili.com/pgc/review/user
 
 *请求方式：GET*

diff --git a/docs/bangumi/timeline.md b/docs/bangumi/timeline.md
@@ -1,12 +1,7 @@
 # 番剧或影视时间线
 
-- [获取番剧或影视时间线](#获取番剧或影视时间线)
-
----
-
 ## 获取番剧或影视时间线
 
-
 > https://api.bilibili.com/pgc/web/timeline
 *请求方式：GET*
 

diff --git a/docs/bangumi/videostream_url.md b/docs/bangumi/videostream_url.md
@@ -4,15 +4,6 @@
 
 B站的番剧视频为http流媒体，需要对应的api以视频id获取取流url，并进行取流
 
-- [qn视频清晰度标识](#qn视频清晰度标识)
-- [fnver视频流版本标识](#fnver视频流版本标识)
-- [fnval视频流格式标识](#fnval视频流格式标识)
-- [视频伴音音质代码](#视频伴音音质代码)
-- [获取番剧视频流URL](#获取番剧视频流URL)
-- [视频的取流（web端及APP端）](#视频的取流web端及APP端)
-
----
-
 ## qn视频清晰度标识
 
 **注：该值在dash模式且非下载模式时无效**