bot/app
3
6.9k
Fork 1
mirror of https://github.com/LiteyukiStudio/LiteyukiBot.git synced 2024-11-11 04:07:23 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: vuepress构建文档

Browse Source
This commit is contained in:
远野千束 2024-03-28 09:38:46 +08:00
parent fafdbea96c
commit f3e45c895d
20 changed files with 255 additions and 269 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -24,3 +24,6 @@ main.cmdY
docs/.vuepress/.cache/
docs/.vuepress/.temp/
docs/.vuepress/dist/
package.json
pnpm-lock.yaml
tsconfig.json

8
docs/.vuepress/config.ts
View File

@ -6,7 +6,13 @@ export default defineUserConfig({
lang: "zh-CN",
title: "LiteyukiBot",
description: "vuepress-theme-hope 的文档演示",
description: "An OneBot Standard ChatBot",
head: [
// 设置 favor.ico，.vuepress/public 下
[
'link', {rel: 'icon', href: 'https://cdn.liteyuki.icu/favicon.ico'}
]
],
theme,

3
docs/.vuepress/navbar.ts
View File

@ -2,5 +2,6 @@ import { navbar } from "vuepress-theme-hope";
export default navbar([
"/",
"/demo/",
"/deployment/",
"/usage/",
]);

BIN
docs/.vuepress/public/favicon.ico
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 66 KiB

After

Width:  |  Height:  |  Size: 66 KiB

18
docs/.vuepress/sidebar.ts
View File

@ -4,22 +4,18 @@ export default sidebar({
"/": [
"",
{
text: "案例",
text: "项目部署",
icon: "laptop-code",
prefix: "demo/",
link: "demo/",
prefix: "deployment/",
link: "deployment/",
children: "structure",
},
{
text: "文档",
icon: "book",
prefix: "guide/",
text: "使用手册",
icon: "laptop-code",
prefix: "usage/",
link: "usage/",
children: "structure",
},
{
text: "幻灯片",
icon: "person-chalkboard",
link: "https://plugin-md-enhance.vuejs.press/zh/guide/content/revealjs/demo.html",
},
],
});

187
docs/.vuepress/theme.js Normal file
View File

@ -0,0 +1,187 @@
import {hopeTheme} from "vuepress-theme-hope";
import navbar from "./navbar.js";
import sidebar from "./sidebar.js";
export default hopeTheme({
hostname: "https://vuepress-theme-hope-docs-demo.netlify.app",
author: {
name: "SnowyKami",
url: "https://snowykami.me",
},
iconAssets: "fontawesome-with-brands",
logo: "https://cdn.liteyuki.icu/static/img/logo.png",
repo: "https://github.com/snowykami/LiteyukiBot",
docsDir: "src",
// 导航栏
navbar,
// 侧边栏
sidebar,
// 页脚
footer: "LiteyukiBot",
displayFooter: true,
// 加密配置
encrypt: {
config: {
"/demo/encrypt.html": ["1234"],
},
},
// 多语言配置
metaLocales: {
editLink: "在 GitHub 上编辑此页",
},
// 如果想要实时查看任何改变，启用它。注: 这对更新性能有很大负面影响
// hotReload: true,
// 在这里配置主题提供的插件
plugins: {
// 你应该自行生成自己的评论服务
comment: {
provider: "Giscus",
repo: "vuepress-theme-hope/giscus-discussions",
repoId: "R_kgDOG_Pt2A",
category: "Announcements",
categoryId: "DIC_kwDOG_Pt2M4COD69",
},
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,
},
// 如果你需要 PWA。安装 @vuepress/plugin-pwa 并取消下方注释
// pwa: {
// favicon: "/favicon.ico",
// cacheHTML: true,
// cachePic: true,
// appendBase: true,
// apple: {
// icon: "/assets/icon/apple-icon-152.png",
// statusBarColor: "black",
// },
// msTile: {
// image: "/assets/icon/ms-icon-144.png",
// color: "#ffffff",
// },
// manifest: {
// icons: [
// {
// src: "/assets/icon/chrome-mask-512.png",
// sizes: "512x512",
// purpose: "maskable",
// type: "image/png",
// },
// {
// src: "/assets/icon/chrome-mask-192.png",
// sizes: "192x192",
// purpose: "maskable",
// type: "image/png",
// },
// {
// src: "/assets/icon/chrome-512.png",
// sizes: "512x512",
// type: "image/png",
// },
// {
// src: "/assets/icon/chrome-192.png",
// sizes: "192x192",
// type: "image/png",
// },
// ],
// shortcuts: [
// {
// name: "Demo",
// short_name: "Demo",
// url: "/demo/",
// icons: [
// {
// src: "/assets/icon/guide-maskable.png",
// sizes: "192x192",
// purpose: "maskable",
// type: "image/png",
// },
// ],
// },
// ],
// },
// },
},
});

187
docs/.vuepress/theme.ts
View File

@ -1,187 +0,0 @@
import { hopeTheme } from "vuepress-theme-hope";
import navbar from "./navbar.js";
import sidebar from "./sidebar.js";
export default hopeTheme({
hostname: "https://vuepress-theme-hope-docs-demo.netlify.app",
author: {
name: "Mr.Hope",
url: "https://mister-hope.com",
},
iconAssets: "fontawesome-with-brands",
logo: "https://theme-hope-assets.vuejs.press/logo.svg",
repo: "vuepress-theme-hope/vuepress-theme-hope",
docsDir: "src",
// 导航栏
navbar,
// 侧边栏
sidebar,
// 页脚
footer: "默认页脚",
displayFooter: true,
// 加密配置
encrypt: {
config: {
"/demo/encrypt.html": ["1234"],
},
},
// 多语言配置
metaLocales: {
editLink: "在 GitHub 上编辑此页",
},
// 如果想要实时查看任何改变，启用它。注: 这对更新性能有很大负面影响
// hotReload: true,
// 在这里配置主题提供的插件
plugins: {
// 你应该自行生成自己的评论服务
comment: {
provider: "Giscus",
repo: "vuepress-theme-hope/giscus-discussions",
repoId: "R_kgDOG_Pt2A",
category: "Announcements",
categoryId: "DIC_kwDOG_Pt2M4COD69",
},
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,
},
// 如果你需要 PWA。安装 @vuepress/plugin-pwa 并取消下方注释
// pwa: {
// favicon: "/favicon.ico",
// cacheHTML: true,
// cachePic: true,
// appendBase: true,
// apple: {
// icon: "/assets/icon/apple-icon-152.png",
// statusBarColor: "black",
// },
// msTile: {
// image: "/assets/icon/ms-icon-144.png",
// color: "#ffffff",
// },
// manifest: {
// icons: [
// {
// src: "/assets/icon/chrome-mask-512.png",
// sizes: "512x512",
// purpose: "maskable",
// type: "image/png",
// },
// {
// src: "/assets/icon/chrome-mask-192.png",
// sizes: "192x192",
// purpose: "maskable",
// type: "image/png",
// },
// {
// src: "/assets/icon/chrome-512.png",
// sizes: "512x512",
// type: "image/png",
// },
// {
// src: "/assets/icon/chrome-192.png",
// sizes: "192x192",
// type: "image/png",
// },
// ],
// shortcuts: [
// {
// name: "Demo",
// short_name: "Demo",
// url: "/demo/",
// icons: [
// {
// src: "/assets/icon/guide-maskable.png",
// sizes: "192x192",
// purpose: "maskable",
// type: "image/png",
// },
// ],
// },
// ],
// },
// },
},
});

4
docs/README.md
View File

@ -12,7 +12,7 @@ tagline: 基于Nonebot2的OneBot标准聊天机器人，不仅仅局限于OneBot
actions:
- text: 使用指南
icon: lightbulb
link: ./demo/
link: ./usage/
type: primary
- text: 文档
@ -25,7 +25,7 @@ actions:
#5. 启动`python main.py`
highlights:
- header: 易于安装
- header: 快速部署
image: /assets/image/box.svg
bgImage: https://theme-hope-assets.vuejs.press/bg/3-light.svg
bgImageDark: https://theme-hope-assets.vuejs.press/bg/3-dark.svg

2
docs/demo/README.md
View File

@ -6,4 +6,4 @@ category:
- 使用指南
---
<Catalog />
<Catalog>a</Catalog>

5
docs/demo/layout.md
View File

@ -1,9 +1,8 @@
---
title: 布局
icon: object-group
order: 2
category:
- 指南
order: 3
category: 使用指南
tag:
- 布局
---

2
docs/demo/page.md
View File

@ -6,7 +6,7 @@ cover: /assets/images/cover1.jpg
# 这是页面的图标
icon: file
# 这是侧边栏的顺序
order: 3
order: 4
# 设置作者
author: Ms.Hope
# 设置写作时间

6
docs/deployment/README.md Normal file
View File

@ -0,0 +1,6 @@
---
title: 快速部署
index: false
icon: laptop-code
category: 安装和配置
---

9
docs/deployment/config.md Normal file
View File

@ -0,0 +1,9 @@
---
title: 配置
icon: object-group
order: 2
category: 使用指南
tag:
- 配置
- 部署
---

14
docs/deployment/install.md Normal file
View File

@ -0,0 +1,14 @@
---
title: 安装
icon: object-group
order: 1
category: 使用指南
tag:
- 安装
---
1. 安装 `Git` 和 `Python3.10+` 环境
2. 克隆项目 `git clone https://github.com/snowykami/LiteyukiBot` (无法连接可以用`https://gitee.com/snowykami/LiteyukiBot`)
3. 切换目录`cd LiteyukiBot`
4. 安装依赖`pip install -r requirements.txt`(如果多个Python环境请指定后安装`pythonx -m pip install -r requirements.txt`)
5. 启动`python main.py`

16
docs/guide/README.md
View File

@ -1,16 +0,0 @@
---
title: 指南
icon: lightbulb
---
## 功能亮点
### Bar
- [baz](bar/baz.md)
- ...
### Foo
- [ray](foo/ray.md)
- ...

13
docs/guide/bar/README.md
View File

@ -1,13 +0,0 @@
---
title: Bar 功能
icon: lightbulb
---
## 介绍
我们支持 bar 功能，...
## 详情
- [baz](baz.md)
- ...

6
docs/guide/bar/baz.md
View File

@ -1,6 +0,0 @@
---
title: Baz
icon: circle-info
---
功能详情...

13
docs/guide/foo/README.md
View File

@ -1,13 +0,0 @@
---
title: Foo 功能
icon: lightbulb
---
## 介绍
我们支持 foo 功能，...
## 详情
- [ray](ray.md)
- ...

6
docs/guide/foo/ray.md
View File

@ -1,6 +0,0 @@
---
title: Ray
icon: circle-info
---
功能详情...

6
docs/usage/README.md Normal file
View File

@ -0,0 +1,6 @@
---
title: 使用指南
index: false
icon: laptop-code
category: 使用指南
---