chore: 升级为 vuepress@2 (#807)

* fix: 修正文档中存在的错误路径，标签和目录 * chore: 升级为 vuepress@2 * fix: vuepress-vite 版本错误
2024-12-25 20:10:06 +08:00 · 2023-09-06 14:25:46 +08:00 · 2023-09-06 14:25:46 +08:00 · ef919a61ef
commit ef919a61ef
parent 92b30f354a
9 changed files with 1312 additions and 8172 deletions
--- a/.vuepress/client.js
+++ b/.vuepress/client.js
@ -0,0 +1,8 @@
+import { defineClientConfig } from '@vuepress/client'
+import Layout from './theme/layouts/Layout.vue'
+
+export default defineClientConfig({
+  layouts: {
+    Layout,
+  },
+})
--- a/.vuepress/config.js
+++ b/.vuepress/config.js
@ -1,40 +1,46 @@
-module.exports = {
+import { defaultTheme, defineUserConfig } from 'vuepress'
+import markdownItTaskLists from 'markdown-it-task-lists'
+import { copyCodePlugin } from "vuepress-plugin-copy-code2";
+
+export default defineUserConfig({
    base: "/bilibili-API-collect/",
+    lang: 'zh-CN',
    title: "BAC Document",
    description: "社区开源的第三方哔哩哔哩 API 文档",
    head: [
-        ['link', { rel: 'icon', href: './logo2.jpg' }]
+        ['link', { rel: 'icon', href: '/logo2.jpg' }]
    ],
    locales: {
        '/': {
            lang: 'zh-CN',
        },
    },
-    themeConfig: {
-        logo: './logo2.jpg',
-        nav: [
-            {text: '首页', link: '/'},
-            {text: '目录', link: '/#🍴目录'},
-            {text: '贡献指南', link: '/CONTRIBUTING.html'},
+    theme: defaultTheme({
+        logo: '/logo2.jpg',
+        navbar: [
+            { text: '首页', link: '/' },
+            { text: '目录', link: '/#🍴目录' },
+            { text: '贡献指南', link: '/CONTRIBUTING.html' },
            {
                text: '相关社群',
-                items: [
-                    {text: 'QQ交流群', link: 'http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=2rRJXK3zgU5yi3e_4rNLeJYUjMLzw_Jj&authKey=L%2FN3EfZXo3QFjEuHq4ifTgh%2F384UmrYpjl7dbYPhYHtznhfJWxkymxQKObQunmEQ&noverify=0&group_code=560304737'},
-                    {text: 'Telegram交流群', link: 'https://t.me/bilibili_API_collect_community'}
+                children: [
+                    { text: 'QQ交流群', link: 'http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=2rRJXK3zgU5yi3e_4rNLeJYUjMLzw_Jj&authKey=L%2FN3EfZXo3QFjEuHq4ifTgh%2F384UmrYpjl7dbYPhYHtznhfJWxkymxQKObQunmEQ&noverify=0&group_code=560304737' },
+                    { text: 'Telegram交流群', link: 'https://t.me/bilibili_API_collect_community' }
                ]
            }
        ],
        sidebar: 'auto',
-        smoothScroll: true,
        repo: 'SocialSisterYi/bilibili-API-collect',
-        editLinks: true,
+        docsBranch: 'master',
        editLinkText: '在 GitHub 上编辑此页',
-    },
-    plugins: [
-        '@vuepress/back-to-top',
-    ],
+    }),
+    plugins: [copyCodePlugin({})],
    markdown: {
-        lineNumbers: true,
-        plugins: ['task-lists']
+        code: {
+            lineNumbers: true
+        }
+    },
+    extendsMarkdown: (md) => {
+        md.use(markdownItTaskLists)
    }
-}
+})
--- a/.vuepress/theme/index.js
+++ b/.vuepress/theme/index.js
@ -1,3 +0,0 @@
-module.exports = {
-    extend: '@vuepress/theme-default'
-}
--- a/.vuepress/theme/layouts/Layout.vue
+++ b/.vuepress/theme/layouts/Layout.vue
@ -1,21 +1,18 @@
 <template>
  <ParentLayout>
    <template #page-bottom>
-      <footer style="text-align: center;">
-        Copyright © 2020-2023 <a href="https://github.com/SocialSisterYi/">SocialSisterYi</a> |
-        <a href="https://github.com/SocialSisterYi/bilibili-API-collect/blob/master/LICENSE">CC-BY-NC-4.0 Licensed</a> 
+      <footer style="text-align: center">
+        Copyright © 2020-2023
+        <a href="https://github.com/SocialSisterYi/">SocialSisterYi</a> |
+        <a
+          href="https://github.com/SocialSisterYi/bilibili-API-collect/blob/master/LICENSE"
+          >CC-BY-NC-4.0 Licensed</a
+        >
      </footer>
    </template>
  </ParentLayout>
 </template>

-<script>
-import ParentLayout from '@parent-theme/layouts/Layout.vue'
-
-export default {
-  name: 'Layout',
-  components: {
-    ParentLayout
-  }
-}
-</script>
+<script setup>
+import ParentLayout from '@vuepress/theme-default/layouts/Layout.vue';
+</script>
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -4,7 +4,7 @@

 ## 总则

-[bilibili-API-collect](https://github.com/SocialSisterYi/bilibili-API-collect) 项目（简称 BAC 或 b-a-c）是一个仅用于学习研究、社区开源、公益性质的 [B站（哔哩哔哩）](https://www.bilibili.com/) API（应用程序接口） 文档，使用 [CC-BY-NC 4.0 协议](LICENSE) 开源，它将无差别收集整理相关的**主站业务接口**。
+[bilibili-API-collect](https://github.com/SocialSisterYi/bilibili-API-collect) 项目（简称 BAC 或 b-a-c）是一个仅用于学习研究、社区开源、公益性质的 [B站（哔哩哔哩）](https://www.bilibili.com/) API（应用程序接口） 文档，使用 [CC-BY-NC 4.0 协议](https://github.com/SocialSisterYi/bilibili-API-collect/blob/master/LICENSE) 开源，它将无差别收集整理相关的**主站业务接口**。

 该项目使用 [MarkDown](https://zh.wikipedia.org/zh-cn/Markdown) 语法进行文档书写，按照业务类型及功能以 **路径** + **文件** 形式索引，任何用户都可通过 Pull Request 提供自己分析出的接口地址与使用说明。

--- a/README.md
+++ b/README.md
@ -2,7 +2,7 @@
    <img src="./assets/img/logo.png" width="250" height="200">
 </p>
 <h1 align="center">哔哩哔哩-API收集整理</h1>
-<p align="center">
+<p align="center" class="shields">
    <a href="https://github.com/SocialSisterYi/bilibili-API-collect/issues" style="text-decoration:none">
        <img src="https://img.shields.io/github/issues/SocialSisterYi/bilibili-API-collect.svg" alt="GitHub issues"/>
    </a>
@ -340,3 +340,9 @@ OR Aifadian：[https://afdian.net/@ShakaiAneE](https://afdian.net/@ShakaiAneE)
 - [grpc/grpc](https://github.com/grpc/grpc): The C based gRPC (C++, Python, Ruby, Objective-C, PHP, C#) 

 - [quicktype](https://github.com/quicktype/quicktype) quicktype generates strongly-typed models and serializers from JSON, JSON Schema, TypeScript, and GraphQL queries, making it a breeze to work with JSON type-safely in many programming languages.一键生成多种语言的json反序列化所需类,以便于快速反序列化, 有网页版
+
+<style scoped>
+  .shields a {
+    margin: auto .5em;
+  }
+</style>
--- a/docs/danmaku/danmaku_xml.md
+++ b/docs/danmaku/danmaku_xml.md
@ -127,19 +127,19 @@ curl 'https://comment.bilibili.com/144541892.xml'

 弹幕的颜色属性使用**十进制RGB888**值

-| 颜色                              | HEX（RGB888）                       | DEC（RGB888）                         |
-| --------------------------------- | ----------------------------------- | ------------------------------------- |
-| <font color="#FE0302">红色</font> | <font color="#FE0302">FE0302</font> | <font color="#FE0302">16646914‬</font> |
-| <font color="#FF7204">橘红</font> | <font color="#FF7204">FF7204</font> | <font color="#FF7204">16740868</font> |
-| <font color="#FFAA02">橘黄</font> | <font color="#FFAA02">FFAA02</font> | <font color="#FFAA02">16755202</font> |
-| <font color="#FFD302">淡黄</font> | <font color="#FFD302">FFD302</font> | <font color="#FFD302">16765698</font> |
-| <font color="#FFFF00">黄色</font> | <font color="#FFFF00">FFFF00</font> | <font color="#FFFF00">16776960</font> |
-| <font color="#A0EE00">草绿</font> | <font color="#A0EE00">A0EE00</font> | <font color="#A0EE00">10546688</font> |
-| <font color="#00CD00">绿色</font> | <font color="#00CD00">00CD00</font> | <font color="#00CD00">52480</font>    |
-| <font color="#019899">墨绿</font> | <font color="#019899">019899</font> | <font color="#019899">104601</font>   |
-| <font color="#4266BE">紫色</font> | <font color="#4266BE">4266BE</font> | <font color="#4266BE">4351678</font>  |
-| <font color="#89D5FF">青色</font> | <font color="#89D5FF">89D5FF</font> | <font color="#89D5FF">9022215</font>  |
-| <font color="#CC0273">品红</font> | <font color="#CC0273">CC0273</font> | <font color="#CC0273">13369971</font> |
-| <font color="#222222">黑色</font> | <font color="#222222">222222</font> | <font color="#222222">2236962</font>  |
-| <font color="#9B9B9B">灰色</font> | <font color="#9B9B9B">9B9B9B</font> | <font color="#9B9B9B">10197915</font> |
-| <font color="#FFFFFF">白色</font> | <font color="#FFFFFF">FFFFFF</font> | <font color="#FFFFFF">16777215</font> |
+| 颜色                                    | HEX（RGB888）                             | DEC（RGB888）                                |
+| -------------------------------------- | ----------------------------------------- | ------------------------------------------- |
+| <font v-pre color="#FE0302">红色</font> | <font v-pre color="#FE0302">FE0302</font> | <font v-pre color="#FE0302">16646914‬</font> |
+| <font v-pre color="#FF7204">橘红</font> | <font v-pre color="#FF7204">FF7204</font> | <font v-pre color="#FF7204">16740868</font> |
+| <font v-pre color="#FFAA02">橘黄</font> | <font v-pre color="#FFAA02">FFAA02</font> | <font v-pre color="#FFAA02">16755202</font> |
+| <font v-pre color="#FFD302">淡黄</font> | <font v-pre color="#FFD302">FFD302</font> | <font v-pre color="#FFD302">16765698</font> |
+| <font v-pre color="#FFFF00">黄色</font> | <font v-pre color="#FFFF00">FFFF00</font> | <font v-pre color="#FFFF00">16776960</font> |
+| <font v-pre color="#A0EE00">草绿</font> | <font v-pre color="#A0EE00">A0EE00</font> | <font v-pre color="#A0EE00">10546688</font> |
+| <font v-pre color="#00CD00">绿色</font> | <font v-pre color="#00CD00">00CD00</font> | <font v-pre color="#00CD00">52480</font>    |
+| <font v-pre color="#019899">墨绿</font> | <font v-pre color="#019899">019899</font> | <font v-pre color="#019899">104601</font>   |
+| <font v-pre color="#4266BE">紫色</font> | <font v-pre color="#4266BE">4266BE</font> | <font v-pre color="#4266BE">4351678</font>  |
+| <font v-pre color="#89D5FF">青色</font> | <font v-pre color="#89D5FF">89D5FF</font> | <font v-pre color="#89D5FF">9022215</font>  |
+| <font v-pre color="#CC0273">品红</font> | <font v-pre color="#CC0273">CC0273</font> | <font v-pre color="#CC0273">13369971</font> |
+| <font v-pre color="#222222">黑色</font> | <font v-pre color="#222222">222222</font> | <font v-pre color="#222222">2236962</font>  |
+| <font v-pre color="#9B9B9B">灰色</font> | <font v-pre color="#9B9B9B">9B9B9B</font> | <font v-pre color="#9B9B9B">10197915</font> |
+| <font v-pre color="#FFFFFF">白色</font> | <font v-pre color="#FFFFFF">FFFFFF</font> | <font v-pre color="#FFFFFF">16777215</font> |
--- a/package.json
+++ b/package.json
@ -5,12 +5,15 @@
  "author": "SocialSisterYi <1440239038@qq.com>",
  "license": "CC-BY-NC-4.0",
  "dependencies": {
-    "@vuepress/plugin-back-to-top": "^1.9.8",
-    "markdown-it-task-lists": "^2.1.1",
-    "vuepress": "^1.9.8"
+    "markdown-it-task-lists": "^2.1.1"
  },
  "scripts": {
    "dev": "vuepress dev",
    "build": "vuepress build"
+  },
+  "devDependencies": {
+    "vuepress": "2.0.0-beta.67",
+    "vuepress-plugin-copy-code2": "2.0.0-beta.237",
+    "vuepress-vite": "2.0.0-beta.67"
  }
 }
--- a/yarn.lock
+++ b/yarn.lock