Skip to content

Commit 8bafbb3

Browse files
committed
update docs
1 parent e98304a commit 8bafbb3

File tree

3 files changed

+56
-32
lines changed

3 files changed

+56
-32
lines changed

docs/.vuepress/config.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
import {myNavbar} from "./navbar";
2-
import {mySidebar} from "./sidebar";
3-
import {defineUserConfig} from "vuepress";
1+
import { myNavbar } from "./navbar";
2+
import { mySidebar } from "./sidebar";
3+
import { defineUserConfig } from "vuepress";
44
import plumeTheme from "vuepress-theme-plume";
5-
import {viteBundler} from '@vuepress/bundler-vite'
6-
import {myBulletin} from "./bulletin";
7-
import {baiduAnalyticsPlugin} from "@vuepress/plugin-baidu-analytics";
8-
import {googleAnalyticsPlugin} from "@vuepress/plugin-google-analytics";
9-
import {umamiAnalyticsPlugin} from "@vuepress/plugin-umami-analytics";
5+
import { viteBundler } from '@vuepress/bundler-vite'
6+
import { myBulletin } from "./bulletin";
7+
import { baiduAnalyticsPlugin } from "@vuepress/plugin-baidu-analytics";
8+
import { googleAnalyticsPlugin } from "@vuepress/plugin-google-analytics";
9+
import { umamiAnalyticsPlugin } from "@vuepress/plugin-umami-analytics";
1010

1111

1212
export default defineUserConfig({
1313
base: '/fastapi_best_architecture_docs/',
1414
lang: 'zh-CN',
1515
title: 'FastAPI Best Architecture',
1616
head: [
17-
['link', {rel: 'icon', href: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.svg'}],
17+
['link', { rel: 'icon', href: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.svg' }],
1818
],
1919
plugins: [
2020
baiduAnalyticsPlugin({
@@ -45,15 +45,15 @@ export default defineUserConfig({
4545
createTime: false,
4646
},
4747
social: [
48-
{icon: 'github', link: 'https://github.com/fastapi-practices/fastapi_best_architecture'},
48+
{ icon: 'github', link: 'https://github.com/fastapi-practices/fastapi_best_architecture' },
4949
{
5050
icon: {
5151
svg: `<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path fill="currentColor" d="M11.984 0A12 12 0 0 0 0 12a12 12 0 0 0 12 12a12 12 0 0 0 12-12A12 12 0 0 0 12 0zm6.09 5.333c.328 0 .593.266.592.593v1.482a.594.594 0 0 1-.593.592H9.777c-.982 0-1.778.796-1.778 1.778v5.63c0 .327.266.592.593.592h5.63c.982 0 1.778-.796 1.778-1.778v-.296a.593.593 0 0 0-.592-.593h-4.15a.59.59 0 0 1-.592-.592v-1.482a.593.593 0 0 1 .593-.592h6.815c.327 0 .593.265.593.592v3.408a4 4 0 0 1-4 4H5.926a.593.593 0 0 1-.593-.593V9.778a4.444 4.444 0 0 1 4.445-4.444h8.296Z"/></svg>`,
5252
name: 'gitee'
5353
},
5454
link: 'https://gitee.com/wu_clan/fastapi_best_architecture'
5555
},
56-
{icon: 'discord', link: 'https://discord.com/invite/yNN3wTbVAC'}
56+
{ icon: 'discord', link: 'https://discord.com/invite/yNN3wTbVAC' }
5757
],
5858
navbarSocialInclude: ['github', 'gitee', 'discord'],
5959
editLinkText: '编辑此页面',
@@ -67,7 +67,7 @@ export default defineUserConfig({
6767
footer: {
6868
copyright: 'Copyright © 2024-present FastAPI Practices'
6969
},
70-
// watermark: false,
70+
//watermark: true,
7171
markdown: {
7272
abbr: true,
7373
annotation: true,

docs/.vuepress/styles/custom.css

Lines changed: 40 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,55 @@
11
:root {
2-
/*--vp-bulletin-width: 385px; !* 公告宽度 *!*/
3-
--vp-c-brand-1: rgba(0, 148, 133, 1); /* 链接颜色、强调色 */
4-
--vp-c-brand-2: rgba(0, 148, 133, 1); /* 链接、按钮 hover 颜色 */
5-
--vp-c-brand-3: rgba(0, 148, 133, 1); /* 背景色、边框色 */
2+
/* 公告宽度 */
3+
/*--vp-bulletin-width: 385px;*/
4+
/* 链接颜色、强调色 */
5+
--vp-c-brand-1: rgba(0, 148, 133, 1);
6+
/* 链接、按钮 hover 颜色 */
7+
--vp-c-brand-2: rgba(0, 148, 133, 1);
8+
/* 背景色、边框色 */
9+
--vp-c-brand-3: rgba(0, 148, 133, 1);
10+
/* 主页 logo 背景色 */
11+
--vp-home-hero-name-color: transparent;
12+
--vp-home-hero-name-background: linear-gradient(120deg, var(--vp-c-purple-1) 30%, var(--vp-c-brand-2));
13+
--vp-home-hero-tagline: var(--vp-c-text-2);
14+
--vp-home-hero-text: var(--vp-c-text-1);
15+
--vp-home-hero-image-background-image: linear-gradient(-45deg, var(--vp-c-brand-soft), var(--vp-c-brand-2));
16+
--vp-home-hero-image-filter: blur(44px);
17+
618
}
719

820
[data-theme="dark"] {
9-
--vp-c-brand-1: rgba(0, 148, 133, 1); /* 链接颜色、强调色 */
10-
--vp-c-brand-2: rgba(0, 148, 133, 1); /* 链接、按钮 hover 颜色 */
11-
--vp-c-brand-3: rgba(0, 148, 133, 1); /* 背景色、边框色 */
21+
/* 链接颜色、强调色 */
22+
--vp-c-brand-1: rgba(0, 148, 133, 1);
23+
/* 链接、按钮 hover 颜色 */
24+
--vp-c-brand-2: rgba(0, 148, 133, 1);
25+
/* 背景色、边框色 */
26+
--vp-c-brand-3: rgba(0, 148, 133, 1);
27+
}
28+
29+
/* 文档式首页 name */
30+
.vp-home-doc-hero .container .main .heading .name {
31+
font-size: 48px !important;
32+
}
33+
34+
35+
/* 文档式首页 text */
36+
.vp-home-doc-hero .container .main .heading .text {
37+
font-size: 48px !important;
1238
}
1339

1440
.vp-repo-card,
1541
.vp-link-card,
1642
.vp-card-wrapper {
17-
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.27), 0 1px 2px rgba(255, 255, 255, 0.22) !important /* 卡片阴影效果 */
43+
/* 卡片阴影效果 */
44+
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.27), 0 1px 2px rgba(255, 255, 255, 0.22) !important;
1845
}
1946

20-
.vp-swiper .swiper-slide-img { /* 轮播图图片拉伸效果 */
47+
.vp-swiper .swiper-slide-img {
48+
/* 轮播图图片拉伸效果 */
2149
object-fit: fill;
2250
}
2351

2452
.swiper-slide-custom-container {
25-
border: 1px solid rgb(177 177 177 / 66%) !important; /* 轮播图边框 */
26-
}
53+
/* 轮播图边框 */
54+
border: 1px solid rgb(177 177 177 / 66%) !important;
55+
}

docs/README.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,12 @@
22
home: true
33
watermark: false
44
config:
5-
- type: hero
6-
full: true
7-
background: tint-plate
5+
- type: doc-hero
86
hero:
97
name: FastAPI Best Architecture
10-
tagline: 企业级后端架构解决方案
11-
text: 基于 FastAPI 框架,前后端分离,遵循「伪三层架构」设计,支持 Python 3.10+ 版本
8+
tagline: 基于 FastAPI 框架,前后端分离,遵循「伪三层架构」设计,支持 Python 3.10+ 版本
9+
text: 企业级后端架构解决方案
10+
image: https://wu-clan.github.io/picx-images-hosting/logo/fba.png
1211
actions:
1312
- theme: brand
1413
text: 快速开始 ->
@@ -49,10 +48,6 @@ config:
4948
icon: 🐳
5049
details: 提供 Docker compose 一键部署方案
5150
- type: custom
52-
- type: profile
53-
name: wu-clan
54-
description: 一个喜欢在夜深人静时进行开源创作的 coder
55-
avatar: https://avatars.githubusercontent.com/u/52145145?v=4
5651
---
5752

5853
<script setup lang="ts">

0 commit comments

Comments
 (0)