Skip to content

Commit

Permalink
细节优化
Browse files Browse the repository at this point in the history
  • Loading branch information
ikenxuan committed Jul 23, 2024
1 parent 6fbdddd commit f870c46
Show file tree
Hide file tree
Showing 7 changed files with 242 additions and 76 deletions.
123 changes: 62 additions & 61 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,13 @@ export default defineConfig({
items: [
{ text: '总目录', link: '/start/index' },
{ text: '快速开始', link: '/start/start' },
{ text: '渲染器', link: '/start/render' }
{ text: '渲染器', link: '/start/render' },
{ text: '渲染器', link: '/start/problems' },
{
text: '疑难杂症', items: [{
text: '常见问题解答', link: '/start/faq'
}]
}
]
},
{
Expand Down Expand Up @@ -155,66 +161,61 @@ export default defineConfig({
},
{ text: '插件索引', link: '/plugins/index' },
],
sidebar: {
'/start/': [
{
text: '快速开始',
items: [
{ text: '目录', link: '/start/index' },
{ text: '框架', link: '/start/start' },
{ text: '渲染器', link: '/start/render' }
],
}
],
'/event/': [
{
text: '事件',
items: [
{ text: '目录', link: '/event/index' },
{ text: '消息事件', link: '/event/message' }
],
}
],
'/plugins/': [
{
text: '插件开发',
items: [
{ text: '目录', link: '/plugins/index' },
{ text: '开发规范', link: '/plugins/standard' },
{ text: 'elements', link: '/plugins/elements' },
{ text: '插件示例', link: '/plugins/demo' },
{ text: '插件包示例', link: '/plugins/package' },
{ text: '插件列表', link: '/plugins/list' }
]
}
],
'/utils/': [
{
text: '开发工具',
items: [
{ text: 'karin', link: '/utils/karin' },
{ text: 'segment', link: '/utils/segment' },
{ text: 'logger', link: '/utils/logger' },
{ text: 'common', link: '/utils/common' },
{ text: 'redis', link: '/utils/redis' },
{ text: 'update', link: '/utils/update' },
{ text: 'YamlEditor', link: '/utils/YamlEditor' },
{ text: 'Renderer', link: '/utils/Renderer' }
]
}
],
'/api/': [
{
text: 'Api',
items: [
{ text: '目录', link: '/api/index' },
{ text: '标准Api', link: '/api/standard' },
{ text: '联系人相关', link: '/api/contact' },
{ text: '消息相关', link: '/api/message' }
]
}
],
},
sidebar: [
{
text: '快速开始',
items: [
{ text: '目录', link: '/start/index' },
{ text: '框架', link: '/start/start' },
{ text: '渲染器', link: '/start/render' },
{
text: '疑难杂症', link: '/start/problems', items: [{
text: '常见问题解答', link: '/start/faq'
}]
}
],
},
{
text: '事件',
items: [
{ text: '目录', link: '/event/index' },
{ text: '消息事件', link: '/event/message' }
],
},
{
text: '插件开发',
items: [
{ text: '目录', link: '/plugins/index' },
{ text: '开发规范', link: '/plugins/standard' },
{ text: 'elements', link: '/plugins/elements' },
{ text: '插件示例', link: '/plugins/demo' },
{ text: '插件包示例', link: '/plugins/package' },
{ text: '插件列表', link: '/plugins/list' }
]
},
{
text: '开发工具',
items: [
{ text: 'karin', link: '/utils/karin' },
{ text: 'segment', link: '/utils/segment' },
{ text: 'logger', link: '/utils/logger' },
{ text: 'common', link: '/utils/common' },
{ text: 'redis', link: '/utils/redis' },
{ text: 'update', link: '/utils/update' },
{ text: 'YamlEditor', link: '/utils/YamlEditor' },
{ text: 'Renderer', link: '/utils/Renderer' }
]
},
{
text: 'Api',
items: [
{ text: '目录', link: '/api/index' },
{ text: '标准Api', link: '/api/standard' },
{ text: '联系人相关', link: '/api/contact' },
{ text: '消息相关', link: '/api/message' }
]
}
],
socialLinks: [
{ icon: 'github', link: 'https://github.com/KarinJS/Karin' },
{
Expand Down
65 changes: 65 additions & 0 deletions docs/.vitepress/theme/components/Ncard.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
<script setup lang="ts">
// @ts-ignore: 2307
import { withDefaults, defineProps } from 'vue'
const props = withDefaults(
// @ts-ignore: 2307
defineProps<{
title: string,
link: string,
target?: string
}>(),
{
target: '_self'
}
)
</script>

<template>
<div class="ncard">
<a :href="props.link" :target="props.target">
<div class="ncardBody">
<div class="card-title text">{{ props.title }}</div>
<div class="card-text text">
<slot></slot>
</div>
</div>
</a>
</div>
</template>

<style scoped>
.ncard {
border: 1px solid #ebedf0;
box-shadow: 2px 2px 8px 1px rgba(0, 0, 0, .15);
margin-bottom: 2em;
border-radius: 8px;
transition: all 200ms ease;
}
.ncard:hover {
border: 1px solid var(--vp-c-brand);
box-shadow: 2px 2px 1px 0 rgba(0, 0, 0, .1);
}
.ncardBody {
padding: 1.8em;
}
a {
color: var(--vp-c-text-1);
text-decoration-line: none;
}
a::after {
content: none !important;
}
.card-title {
font-size: 1.5em;
margin-bottom: .8em;
}
.card-text {
font-size: 0.9em;
}
</style>
5 changes: 4 additions & 1 deletion docs/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,21 @@ import {
} from '@nolebase/vitepress-plugin-highlight-targeted-heading/client'
// 快速复制当前页的url
import Share from './components/Share.vue'
import Ncard from './components/Ncard.vue'
// 页面属性
import {
NolebasePagePropertiesPlugin,
} from '@nolebase/vitepress-plugin-page-properties/client'
import '@nolebase/vitepress-plugin-page-properties/client/style.css'
// <mark> 元素增强
import '@nolebase/vitepress-plugin-enhanced-mark/client/style.css'

export default {
extends: DefaultTheme,
enhanceApp ({ app }) {
app.component('NCard', Ncard)
app.use(NolebaseGitChangelogPlugin)
app.use(NolebaseInlineLinkPreviewPlugin)
// app.use(NuAsciinemaPlayer)
app.use(NolebasePagePropertiesPlugin<{
progress: number
}>(), {
Expand Down
1 change: 1 addition & 0 deletions docs/start/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# 编写中,咕咕咕~
28 changes: 16 additions & 12 deletions docs/start/index.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,26 @@
#

## 目录
# 目录
::: tip 温馨提示
如果文档中发现错误,或提交文档修改,或丰富本站文档,可点击页面底部的编辑按钮
:::

### 快速开始

- [安装karin](./start.md)
<br>
<NCard title="🎲 安装karin" link="start/">
第一次使用 Karin 而且晕头转向?来看看这份安装指引吧!
</NCard>

### 渲染器

- [安装渲染器](./render.md)
<br>
<NCard title="📑 安装渲染器" link="render/">
Karin 的渲染器是独立的一个项目,需要单独安装噢
</NCard>

### 插件
<br>
<NCard title="😍 安装插件" link="../plugins/">
Karin 社区拥有众多开发者,开发了许多特色插件,你可以在插件市场找到你想要的插件~
</NCard>

- [安装插件](../plugins/index.md)

### 完善此文档

[点击此处跳转到文档贡献页面](https://github.com/KarinJS/Karin/tree/docs)

<!-- - <Badge type="info" text="default" />
- <Badge type="tip" text="^1.9.0" />
Expand Down
89 changes: 89 additions & 0 deletions docs/start/problems.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
---
outline: [2, 4]
---

# 遇到问题了咋办

> 任何事物都不可能尽善尽美,Karin 也是如此。
如果你在使用 Karin 的过程中遇到了任何问题(包括但不限于如何登录、无法连接渲染器等),请认真阅读并充分理解下述内容,这会对你有帮助。

## 遇到问题后的第一反应

<div align="center" style="line-height: 1.5em; font-size: 1.5em; padding: 2em 1em; margin: 2em 0; border: 1px solid var(--vp-c-text-1); border-radius: 8px">不要急,也不要慌,更不要气急败坏。</div>

大部分情况下,Karin 是可以正常运行的。

👉 所以在遇到问题时,你应该**检查一下是不是你自己的问题**,比如:网络错误、操作错误,甚至你自己的浏览器都可能导致你无法正常使用 Karin。所以,<mark>在提问之前,请先以自己的经验判断一下,这是不是你自己的问题</mark>。

👉 其次,你应该**阅读一遍 [**《常见问题解答 / FAQ》**](./faq.md)**。<mark>很多情况下你遇到的问题也曾经困扰过很多人,并且已经被总结出了解决方案。</mark>这种情况下,直接查阅这份 FAQ 能更快地解决你的问题。

<NCard title="🤔 常见问题解答 / FAQ" link="faq/">
说不定就有你正在努力寻找的答案。
</NCard>

如果你确定不是你自己的问题,并且你遇到的问题并未列举在 FAQ 中,你可以着手准备报告问题了。

## 开发团队,或是帮助你的人,并不是神

看起来你们大多数人好像都不知道的样子?

那就让我们来告诉你们一个真理吧:

<div align="center" style="padding: 2em; margin: 2em 0; border: 1px solid var(--vp-c-text-1); border-radius: 8px">
<p align="left">Troubleshooting any problem without the error log is like driving with your eyes closed.</p>
<p align="right" style="font-size: 1.15em">在没有错误日志的情况下诊断任何问题无异于闭眼开车。</p>
</div>

也就是说,不管是谁,都 **很难通过只言片语快速定位你的问题**

所以,在每一次报告问题时,<mark>不要只丢下一句「适配器报错了」、「连不上上唧唧人了」就跑了。在没有日志、报错截图等信息的辅助下,我们 **不可能** 知道网线对面的你到底遇到了什么问题。</mark>

为了得到高效且愉悦的帮助,建议你按照以下步骤来报告问题 :point_down:

## 我应该提供哪些信息?

可能需要视情况而定。这里列举几个通用的,重点部分已被我们加粗。

> [!NOTE] 感觉看不懂?
> 如果你难以判断你需要提供哪些内容,请尽可能详细地描述你的问题,我们的支持团队会指导你提供相关信息。
### 1. 报错截图 <Badge type="info" text="控制台" />

如果是 Karin 的问题,发生错误时,Karin 应该会给出相应的提示。一般情况下都是红色的错误警告。
<mark>**请把相关的提示乃至整个屏幕截图**,并在提问时提供。</mark>

### 2. 复现步骤 <Badge type="info">控制台</Badge><Badge type="info">适配器</Badge><Badge type="info" text="聊天记录" />

许多问题 **只会在特定的操作下出现** 。提供复现步骤可以让我们了解你的问题是在何种操作下出现的,并快速定位问题所在和解决问题。

你可以从以下四个问题入手:

1. 你想要进行什么操作?为的是达到什么目的?
2. 在问题发生之前,你分别都进行了哪些操作?
3. <Badge type="info" text="控制台" /> 你正在使用什么版本的 Node.js?你的操作系统是什么?网络环境是什么?
4. <Badge type="info" text="适配器" /> 你使用的是哪个适配器?是否已经更新到最新版本?
5. <Badge type="info" text="聊天记录" /> 你是否可以提供一些关于问题的聊天记录?(次要)

若能在提问时提供上述信息,则将极大提高我们提供精准服务的效率。

### 3. 日志 <Badge type="info" text="控制台" />

日志文件记录了程序在运行过程中的详细信息,包括操作记录、错误提示、警告信息等。

日志之所以被设计出来,就是因为它可以帮助支持人员快速定位问题的根源,从而提供更准确的解决方案。

各种日志是侦错时不可缺少的信息,所以如果有,提问时请带上这些日志:

<mark>提供日志时,**请发送完整的日志截图****最好不要使用手机摄像头拍摄** ,如果没有这些日志,请在提问时说明清楚;如果你提问后被要求提供更多信息,请提供我们要求的信息以帮助我们查找问题。</mark>

## 我该去哪里提问?

<p style="margin-bottom: 2em"></p>

<NCard title="🙋 获取即时支持" link="http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=kDN3vwVj8Qozw94TWX69r24vxrWqkgMy&authKey=NxnqHYmo8037jCeDkO9yIFPOdQxkKa4JlxC%2FAV6UNxwGc%2FwKEVoogi44syB3BWuC&noverify=0&group_code=967068507" >
你可以加入我们的官方用户交流群来提问
</NCard>
<NCard title="📬️ 通过 GitHub Issue" link="https://github.com/KarinJS/Karin/issues/new/choose" >
也可以给通过创建新的 GitHub Issue 工单
</NCard>
7 changes: 5 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,24 @@
"build": "vitepress build docs",
"preview": "vitepress preview docs"
},
"devDependencies": {
"vitepress": "^1.3.1"
},
"dependencies": {
"@nolebase/markdown-it-bi-directional-links": "^2.2.2",
"@nolebase/vitepress-plugin-enhanced-mark": "^2.2.2",
"@nolebase/vitepress-plugin-enhanced-readabilities": "^2.2.2",
"@nolebase/vitepress-plugin-git-changelog": "^2.2.2",
"@nolebase/vitepress-plugin-highlight-targeted-heading": "^2.2.2",
"@nolebase/vitepress-plugin-inline-link-preview": "^2.2.2",
"@nolebase/vitepress-plugin-meta": "^2.2.2",
"@nolebase/vitepress-plugin-page-properties": "^2.2.2",
"@vitejs/plugin-vue": "^5.0.5",
"@vueuse/core": "^10.11.0",
"markdown-it-footnote": "^4.0.0",
"markdown-it-mathjax3": "^4.3.2",
"markdown-it-task-lists": "^2.1.1",
"medium-zoom": "^1.1.0",
"vite": "^5.3.4",
"vitepress": "^1.3.1",
"vitepress-markdown-timeline": "^1.2.1",
"vitepress-plugin-codeblocks-fold": "^1.2.28",
"vue": "^3.4.33"
Expand Down

0 comments on commit f870c46

Please sign in to comment.