Skip to content

Commit 7818322

Browse files
committed
update docs
1 parent 02a0736 commit 7818322

File tree

6 files changed

+37
-31
lines changed

6 files changed

+37
-31
lines changed

docs/.vuepress/components/BannerTop.vue

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,28 @@
11
<script setup>
2-
import { onMounted, ref } from "vue";
2+
import { useStorage } from "@vueuse/core";
33
4-
const isDismissed = ref(false);
4+
const isDismissed = useStorage("fba-docs-banner-top", true);
55
66
function dismiss() {
7-
isDismissed.value = true;
7+
isDismissed.value = false;
88
if (typeof window !== 'undefined') {
9-
localStorage.setItem("fba-docs-banner-top", "true");
9+
localStorage.setItem("fba-docs-banner-top", false);
1010
}
1111
updateDocumentClass();
1212
}
1313
1414
function updateDocumentClass() {
15+
console.log(isDismissed.value);
1516
if (typeof window !== 'undefined') {
16-
document.documentElement.classList.toggle("banner-dismissed", isDismissed.value);
17+
document.documentElement.classList.toggle("banner-dismissed", !isDismissed.value);
1718
}
1819
}
1920
20-
onMounted(() => {
21-
if (typeof window !== 'undefined') {
22-
isDismissed.value = localStorage.getItem("fba-docs-banner-top") === "true";
23-
updateDocumentClass();
24-
}
25-
});
21+
updateDocumentClass();
2622
</script>
2723

2824
<template>
29-
<div v-if="!isDismissed" class="banner">
25+
<div class="banner">
3026
<p class="vp-banner-text">
3127
<span class="vp-text-primary">FBA </span>
3228
<span class="vp-tagline">· FasAPI</span>

docs/.vuepress/components/SponsorPanel.vue

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
</template>
5555

5656
<script setup>
57-
import { computed, onMounted, ref } from "vue";
57+
import { computed, onMounted } from "vue";
5858
import {
5959
defaultSponsor,
6060
generalSponsors,
@@ -63,8 +63,9 @@ import {
6363
shouldShowSponsor,
6464
sponsorUrl
6565
} from "../data/sponsors";
66+
import { useStorage } from "@vueuse/core";
6667
67-
const isCollapsed = ref(false);
68+
const isCollapsed = useStorage('fba-docs-sponsor-collapsed', false);
6869
6970
const processedGoldSponsors = computed(() => {
7071
return goldSponsors.map(brand => {
@@ -86,16 +87,9 @@ const shouldShowExtraBecomeSponsor = computed(() => {
8687
const toggleCollapse = () => {
8788
isCollapsed.value = !isCollapsed.value;
8889
if (typeof window !== 'undefined') {
89-
localStorage.setItem("sponsorCollapsed", isCollapsed.value);
90+
localStorage.setItem("fba-docs-sponsor-collapsed", isCollapsed.value);
9091
}
9192
};
92-
93-
onMounted(() => {
94-
if (typeof window !== 'undefined') {
95-
const savedState = localStorage.getItem("sponsorCollapsed");
96-
isCollapsed.value = savedState ? savedState === "true" : false;
97-
}
98-
});
9993
</script>
10094

10195
<style scoped>

docs/.vuepress/sidebar.ts

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ export const mySidebar: ThemeSidebarMulti = {
3232
{ text: 'Schema', link: 'schema' },
3333
{ text: '路由', link: 'router' },
3434
{ text: 'CRUD', link: 'CRUD' },
35-
{ text: '分页', link: 'pagination' },
3635
{ text: '接口响应', link: 'response' },
36+
{ text: '分页', link: 'pagination' },
3737
{ text: '自定义异常', link: '/planet', icon: 'fluent-color:receipt-16' },
3838
{ text: '节流', link: 'limit' },
3939
{ text: '切换数据库', link: 'db' },
@@ -63,13 +63,25 @@ export const mySidebar: ThemeSidebarMulti = {
6363
],
6464
'/plugin/': [
6565
{
66-
text: '插件',
66+
text: '介绍',
6767
collapsed: false,
6868
items: [
6969
{ text: '前言', link: 'before' },
70+
{ text: '快速开始', link: 'install' },
71+
]
72+
},
73+
{
74+
text: '开发',
75+
collapsed: true,
76+
items: [
7077
{ text: '插件开发', link: 'dev' },
7178
{ text: '插件发布', link: 'publish' },
72-
{ text: '安装使用', link: 'install' },
79+
]
80+
},
81+
{
82+
text: '市场',
83+
collapsed: false,
84+
items: [
7385
{ text: '插件市场', badge: { text: 'New' }, link: 'market' },
7486
]
7587
}

docs/.vuepress/styles/custom.css

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,12 @@
4444
margin: 24px 0 40px !important;
4545
}
4646

47+
/* 首页 box */
48+
.vp-home-feature:hover {
49+
border: 1px solid var(--vp-c-brand-1);
50+
background-color: rgba(0, 148, 133, 0.1);
51+
}
52+
4753
.vp-swiper .swiper-slide-img {
4854
/* 轮播图图片拉伸效果 */
4955
object-fit: fill;

docs/plugin/install.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: 安装使用
2+
title: 快速开始
33
---
44

5-
插件安装方式包含以下两种
5+
您可以将 [插件市场](./market.md) 中的插件通过以下方式进行安装
66

77
:::: tabs
8-
@tab 1. 手动
8+
@tab 手动
99

1010
1. 获取插件仓库源码并下载
1111
2. 将源码中的插件目录直接拷贝到 fba 项目对应的目录下
@@ -23,7 +23,7 @@ title: 安装使用
2323
3. 如果插件包含依赖(requirements.txt),执行 `backend/scripts/init_plugin.py` 文件安装依赖
2424
4. 根据插件使用说明完成安装
2525

26-
@tab 2. 自动
26+
@tab 半自动
2727

2828
1. 获取打包好的插件 zip 压缩包 <Badge type="warning" text="二选一" />
2929

docs/plugin/market.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ title: 插件市场
1616

1717
## 内置
1818

19-
这些插件由 fba 内置
20-
2119
<CardGrid>
2220
<Card icon="charm:shield-keyhole" title="Casbin-RBAC">
2321
<p style="color: #898989;">基于 Casbin 实现的 RBAC 权限</p>

0 commit comments

Comments
 (0)