📝 文档迁移到 vuepress hope 主题 (#490)

* ⬆️ Bump the docs-update group with 3 updates

Bumps the docs-update group with 3 updates: [@vuepress/client](https://github.com/vuepress/core), [vue](https://github.com/vuejs/core) and [vuepress](https://github.com/vuejs/vuepress/tree/HEAD/packages/vuepress).


Updates `@vuepress/client` from 2.0.0-rc.0 to 2.0.0-rc.2
- [Release notes](https://github.com/vuepress/core/releases)
- [Changelog](https://github.com/vuepress/core/blob/main/CHANGELOG.md)
- [Commits](https://github.com/vuepress/core/compare/v2.0.0-rc.0...v2.0.0-rc.2)

Updates `vue` from 3.4.3 to 3.4.21
- [Release notes](https://github.com/vuejs/core/releases)
- [Changelog](https://github.com/vuejs/core/blob/main/CHANGELOG.md)
- [Commits](https://github.com/vuejs/core/compare/v3.4.3...v3.4.21)

Updates `vuepress` from 2.0.0-rc.0 to 2.0.0-rc.8
- [Release notes](https://github.com/vuejs/vuepress/releases)
- [Changelog](https://github.com/vuejs/vuepress/blob/master/CHANGELOG.md)
- [Commits](https://github.com/vuejs/vuepress/commits/HEAD/packages/vuepress)

---
updated-dependencies:
- dependency-name: "@vuepress/client"
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: docs-update
- dependency-name: vue
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: docs-update
- dependency-name: vuepress
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: docs-update
...

Signed-off-by: dependabot[bot] <support@github.com>

* 💄 auto fix by pre-commit hooks

* 📝 使用 vuepress hope 主题

* 📝 更新文档中的过时内容

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Azide <rukuy@qq.com>
This commit is contained in:
dependabot[bot]
2024-03-18 18:37:17 +08:00
committed by GitHub
parent a6a2cc1be7
commit ed0933038e
25 changed files with 3220 additions and 2685 deletions
+11 -30
View File
@@ -1,34 +1,15 @@
import { defineUserConfig, defaultTheme } from "vuepress";
import { defineUserConfig } from "vuepress";
import theme from "./theme.js";
export default defineUserConfig({
base: "/",
lang: "zh-CN",
title: "Nonebot Bison",
description: "Docs for Nonebot Bison",
theme: defaultTheme({
navbar: [
{ text: "主页", link: "/" },
{
text: "使用",
children: [
{
text: "安装",
link: "/usage/install.md",
activeMatch: "^/usage/install",
},
{
text: "入门",
link: "/usage/easy-use.md",
activeMatch: "^/usage/easy-use",
},
{
text: "详述",
link: "/usage",
activeMatch: "^/usage$",
},
],
},
{ text: "开发", link: "/dev/" },
{ text: "Github", link: "https://github.com/felinae98/nonebot-bison" },
],
}),
title: "NoneBot Bison",
description: "NoneBot Bison 文档",
theme,
// 和 PWA 一起启用
// shouldPrefetch: false,
});
+33
View File
@@ -0,0 +1,33 @@
import { navbar } from "vuepress-theme-hope";
export default navbar([
"/",
{
text: "指南",
icon: "book",
prefix: "/usage/",
children: [
{
text: "安装",
icon: "box-open",
link: "install",
},
{
text: "快速开始",
icon: "truck-fast",
link: "easy-use",
},
{
text: "详细介绍",
icon: "motorcycle",
link: "",
activeMatch: "^/usage/?$",
},
],
},
{
text: "开发",
icon: "flask",
link: "/dev/",
},
]);
File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 9.8 KiB

@@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="200" height="200" class="icon" viewBox="0 0 1024 1024"><path fill="#FDD7AD" d="M512 0 335.448 88.272l-70.616 35.312-70.624 35.312-176.552 88.28v529.648L512 1024l494.344-247.176V247.176z"/><path fill="#CBB292" d="m759.176 370.76-70.624 35.304-494.344-247.168 70.624-35.312zM512 494.344V1024L17.656 776.824V247.176z"/><path fill="#7F6E5D" d="M1006.344 247.168v529.656L512 1024V494.344l176.552-88.28v70.624l141.24-70.624v-70.616z"/><path fill="#7F5B53" d="M829.792 335.448v70.624L688.56 476.68v-70.624z"/><path fill="#CBB292" d="m829.792 335.448-70.624 35.312-494.344-247.176 70.624-35.312z"/><path fill="#2C3E50" d="m682.52 550.32 157.032-78.512a17.656 17.656 0 0 1 25.552 15.792v9.32a52.96 52.96 0 0 1-29.28 47.376L678.8 622.8a17.656 17.656 0 0 1-25.552-15.792v-9.312a52.96 52.96 0 0 1 29.28-47.376z"/></svg>

After

Width:  |  Height:  |  Size: 854 B

@@ -0,0 +1 @@
<svg width="98" height="96" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M48.854 0C21.839 0 0 22 0 49.217c0 21.756 13.993 40.172 33.405 46.69 2.427.49 3.316-1.059 3.316-2.362 0-1.141-.08-5.052-.08-9.127-13.59 2.934-16.42-5.867-16.42-5.867-2.184-5.704-5.42-7.17-5.42-7.17-4.448-3.015.324-3.015.324-3.015 4.934.326 7.523 5.052 7.523 5.052 4.367 7.496 11.404 5.378 14.235 4.074.404-3.178 1.699-5.378 3.074-6.6-10.839-1.141-22.243-5.378-22.243-24.283 0-5.378 1.94-9.778 5.014-13.2-.485-1.222-2.184-6.275.486-13.038 0 0 4.125-1.304 13.426 5.052a46.97 46.97 0 0 1 12.214-1.63c4.125 0 8.33.571 12.213 1.63 9.302-6.356 13.427-5.052 13.427-5.052 2.67 6.763.97 11.816.485 13.038 3.155 3.422 5.015 7.822 5.015 13.2 0 18.905-11.404 23.06-22.324 24.283 1.78 1.548 3.316 4.481 3.316 9.126 0 6.6-.08 11.897-.08 13.526 0 1.304.89 2.853 3.316 2.364 19.412-6.52 33.405-24.935 33.405-46.691C97.707 22 75.788 0 48.854 0z" fill="#24292f"/></svg>

After

Width:  |  Height:  |  Size: 963 B

@@ -0,0 +1 @@
<svg width="98" height="96" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M48.854 0C21.839 0 0 22 0 49.217c0 21.756 13.993 40.172 33.405 46.69 2.427.49 3.316-1.059 3.316-2.362 0-1.141-.08-5.052-.08-9.127-13.59 2.934-16.42-5.867-16.42-5.867-2.184-5.704-5.42-7.17-5.42-7.17-4.448-3.015.324-3.015.324-3.015 4.934.326 7.523 5.052 7.523 5.052 4.367 7.496 11.404 5.378 14.235 4.074.404-3.178 1.699-5.378 3.074-6.6-10.839-1.141-22.243-5.378-22.243-24.283 0-5.378 1.94-9.778 5.014-13.2-.485-1.222-2.184-6.275.486-13.038 0 0 4.125-1.304 13.426 5.052a46.97 46.97 0 0 1 12.214-1.63c4.125 0 8.33.571 12.213 1.63 9.302-6.356 13.427-5.052 13.427-5.052 2.67 6.763.97 11.816.485 13.038 3.155 3.422 5.015 7.822 5.015 13.2 0 18.905-11.404 23.06-22.324 24.283 1.78 1.548 3.316 4.481 3.316 9.126 0 6.6-.08 11.897-.08 13.526 0 1.304.89 2.853 3.316 2.364 19.412-6.52 33.405-24.935 33.405-46.691C97.707 22 75.788 0 48.854 0z" fill="#fff"/></svg>

After

Width:  |  Height:  |  Size: 960 B

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 640 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 282 KiB

+37
View File
@@ -0,0 +1,37 @@
import { sidebar } from "vuepress-theme-hope";
export default sidebar({
"/": [
"",
{
text: "指南",
icon: "laptop-code",
prefix: "usage/",
children: "structure",
},
{
text: "开发",
icon: "terminal",
prefix: "dev/",
children: "structure",
},
{
text: "相关",
icon: "person-chalkboard",
children: [
{
text: "Nonebot-Bison",
link: "https://github.com/MountainDash/nonebot-bison",
},
{
text: "Nonebot-Plugin-SAA",
link: "https://github.com/MountainDash/nonebot-plugin-send-anything-anywhere",
},
{
text: "MountainDash",
link: "https://github.com/MountainDash/",
},
],
},
],
});
+3
View File
@@ -0,0 +1,3 @@
// you can change config here
$colors: #c0392b, #d35400, #f39c12, #27ae60, #16a085, #2980b9, #8e44ad, #2c3e50,
#7f8c8d !default;
+1
View File
@@ -0,0 +1 @@
// place your custom styles here
+2
View File
@@ -0,0 +1,2 @@
// you can change colors here
$theme-color: #096dd9;
+121
View File
@@ -0,0 +1,121 @@
import { hopeTheme } from "vuepress-theme-hope";
import navbar from "./navbar.js";
import sidebar from "./sidebar.js";
export default hopeTheme({
hostname: "https://nonebot-bison.netlify.app",
author: {
name: "MountainDash Team",
url: "https://github.com/orgs/MountainDash/teams",
},
iconAssets: "fontawesome-with-brands",
logo: "logo.svg",
repo: "MountainDash/nonebot-bison",
docsDir: "docs",
// 导航栏
navbar,
// 侧边栏
sidebar,
// 页脚
footer: "默认页脚",
displayFooter: true,
// 加密配置
encrypt: {
config: {
"/demo/encrypt.html": ["1234"],
},
},
// 多语言配置
metaLocales: {
editLink: "在 GitHub 上编辑此页",
},
// 如果想要实时查看任何改变,启用它。注: 这对更新性能有很大负面影响
// hotReload: true,
// 在这里配置主题提供的插件
plugins: {
components: {
components: ["Badge", "VPCard"],
},
// 此处开启了很多功能用于演示,你应仅保留用到的功能。
mdEnhance: {
align: true,
attrs: true,
codetabs: true,
component: true,
demo: true,
figure: true,
imgLazyload: true,
imgSize: true,
include: true,
mark: true,
stylize: [
{
matcher: "Recommended",
replacer: ({ tag }) => {
if (tag === "em")
return {
tag: "Badge",
attrs: { type: "tip" },
content: "Recommended",
};
},
},
],
sub: true,
sup: true,
tabs: true,
vPre: true,
// 在启用之前安装 chart.js
// chart: true,
// insert component easily
// 在启用之前安装 echarts
// echarts: true,
// 在启用之前安装 flowchart.ts
// flowchart: true,
// gfm requires mathjax-full to provide tex support
// gfm: true,
// 在启用之前安装 katex
// katex: true,
// 在启用之前安装 mathjax-full
// mathjax: true,
// 在启用之前安装 mermaid
// mermaid: true,
// playground: {
// presets: ["ts", "vue"],
// },
// 在启用之前安装 reveal.js
// revealJs: {
// plugins: ["highlight", "math", "search", "notes", "zoom"],
// },
// 在启用之前安装 @vue/repl
// vuePlayground: true,
// install sandpack-vue3 before enabling it
// sandpack: true,
},
},
});