update docs

Author: wu-clan

docs/.vuepress/config.ts

@@ -1,11 +1,9 @@
-import { myNavbar } from "./navbar";
-import { mySidebar } from "./sidebar";
 import { defineUserConfig } from "vuepress";
-import plumeTheme from "vuepress-theme-plume";
 import { viteBundler } from '@vuepress/bundler-vite'
-import { myBulletin } from "./bulletin";
 import { baiduAnalyticsPlugin } from "@vuepress/plugin-baidu-analytics";
 import { umamiAnalyticsPlugin } from "@vuepress/plugin-umami-analytics";
+import { llmsPlugin } from "@vuepress/plugin-llms";
+import { myTheme } from "./theme";
 
 
 export default defineUserConfig({
@@ -15,71 +13,16 @@ export default defineUserConfig({
     head: [
         ['link', { rel: 'icon', href: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.svg' }],
     ],
+    theme: myTheme,
     plugins: [
         baiduAnalyticsPlugin({
             id: '6202e3701ae5a932577a1cf195084e9e'
         }),
         umamiAnalyticsPlugin({
             id: '62984e7c-ec95-459a-9a2f-553766c6b3d4'
-        })
+        }),
+        llmsPlugin({})
     ],
-    theme: plumeTheme({
-        hostname: 'https://fastapi-practices.github.io/fastapi_best_architecture_docs/',
-        logo: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.png',
-        docsRepo: 'https://github.com/fastapi-practices/fastapi_best_architecture_docs',
-        docsBranch: 'master',
-        docsDir: 'docs',
-        blog: false,
-        notes: false,
-        bulletin: myBulletin,
-        sidebar: mySidebar,
-        sidebarScrollbar: false,
-        navbar: myNavbar,
-        autoFrontmatter: {
-            title: true,
-            permalink: false,
-            createTime: false,
-        },
-        social: [
-            { icon: 'github', link: 'https://github.com/fastapi-practices/fastapi_best_architecture' },
-            {
-                icon: {
-                    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>`,
-                    name: 'gitee'
-                },
-                link: 'https://gitee.com/wu_clan/fastapi_best_architecture'
-            },
-        ],
-        navbarSocialInclude: ['github', 'gitee', 'bilibili'],
-        editLinkText: '编辑此页面',
-        contributors: false,
-        lastUpdated: false,
-        footer: {
-            message: 'FastAPI 最佳架构 & MIT LICENCE',
-            copyright: 'Copyright © 2023-present FastAPI Practices'
-        },
-        //watermark: true,
-        markdown: {
-            abbr: true,
-            annotation: true,
-            mermaid: true,
-        },
-        codeHighlighter: {
-            themes: {
-                dark: 'one-dark-pro',
-                light: 'one-light'
-            }
-        },
-        comment: {
-            provider: 'Giscus',
-            comment: true,
-            repo: 'fastapi-practices/fastapi_best_architecture_docs',
-            repoId: 'R_kgDOMv5sMQ',
-            category: 'Comment',
-            categoryId: 'DIC_kwDOMv5sMc4CmLp9',
-            lazyLoading: true,
-        },
-    }),
     bundler: viteBundler(),
     shouldPrefetch: false,
 })

docs/.vuepress/navbar.ts

@@ -1,6 +1,6 @@
-import { defineNavbarConfig } from "vuepress-theme-plume";
+import { defineNavbarConfig, ThemeNavItem } from "vuepress-theme-plume";
 
-export const myNavbar = defineNavbarConfig([
+export const myNavbar: ThemeNavItem[] = defineNavbarConfig([
     {
         text: '前端（在线体验）',
         items: [
@@ -120,7 +120,7 @@ export const myNavbar = defineNavbarConfig([
         text: '生态系统',
         items: [
             {
-                text: '资源',
+                text: '生态',
                 items: [
                     {
                         text: '开源项目',

docs/.vuepress/theme.ts

@@ -0,0 +1,64 @@
+import plumeTheme from "vuepress-theme-plume";
+import { Theme } from "vuepress";
+import { myBulletin } from "./bulletin";
+import { mySidebar } from "./sidebar";
+import { myNavbar } from "./navbar";
+
+
+export const myTheme: Theme = plumeTheme({
+    hostname: 'https://fastapi-practices.github.io/fastapi_best_architecture_docs/',
+    logo: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.png',
+    docsRepo: 'https://github.com/fastapi-practices/fastapi_best_architecture_docs',
+    docsBranch: 'master',
+    docsDir: 'docs',
+    blog: false,
+    notes: false,
+    bulletin: myBulletin,
+    sidebar: mySidebar,
+    sidebarScrollbar: false,
+    navbar: myNavbar,
+    autoFrontmatter: {
+        title: true,
+        permalink: false,
+        createTime: false,
+    },
+    social: [
+        { icon: 'github', link: 'https://github.com/fastapi-practices/fastapi_best_architecture' },
+        {
+            icon: {
+                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>`,
+                name: 'gitee'
+            },
+            link: 'https://gitee.com/wu_clan/fastapi_best_architecture'
+        },
+    ],
+    navbarSocialInclude: ['github', 'bilibili'],
+    editLinkText: '编辑此页面',
+    contributors: false,
+    lastUpdated: false,
+    footer: {
+        message: 'FastAPI 最佳架构 & MIT LICENCE',
+        copyright: 'Copyright © 2023-present FastAPI Practices'
+    },
+    //watermark: true,
+    markdown: {
+        abbr: true,
+        annotation: true,
+        mermaid: true,
+    },
+    codeHighlighter: {
+        themes: {
+            dark: 'one-dark-pro',
+            light: 'one-light'
+        }
+    },
+    comment: {
+        provider: 'Giscus',
+        comment: true,
+        repo: 'fastapi-practices/fastapi_best_architecture_docs',
+        repoId: 'R_kgDOMv5sMQ',
+        category: 'Comment',
+        categoryId: 'DIC_kwDOMv5sMc4CmLp9',
+        lazyLoading: true,
+    },
+})

docs/backend/summary/why.md

@@ -12,7 +12,7 @@ import NpmBadge from 'vuepress-theme-plume/features/NpmBadge.vue'
 > [!IMPORTANT]
 > 我们不会去对比任何其他架构，我们认为每个架构都有自己的特点，适用于不同的场景。
 >
-> 但 fba 绝对是开源架构中代码==最干净，最规范且最令人赏心悦目=={.note}的项目之一
+> 但 fba 绝对是开源架构中，==代码最整洁，最规范且最令人赏心悦目的项目之一=={.important}
 
 ## 目标
 

docs/team.md

@@ -1,7 +1,8 @@
 ---
 pageLayout: friends
 title: FastAPI Practices
-description: FastAPI Practices 及其生态系统发展的背后是一个由开源社区人员组成的团队，我们对团队中的任何成员以及所有的关注者都致以崇高的敬意；
+description: >-
+  FastAPI Practices 及其生态系统发展的背后是一个由开源社区人员组成的团队，我们对团队中的任何成员以及所有的关注者都致以崇高的敬意；
   我们欢迎每一位开源伙伴的加入。
 contentPosition: before
 groups:
@@ -14,21 +15,24 @@ groups:
         desc: 一个喜欢在夜深人静时进行开源创作的 coder
         location: 郑州，河南
         organization: FastAPI Practices
-        socials: [
-          { icon: 'github', link: 'https://github.com/wu-clan' },
-          { icon: 'x', link: 'https://twitter.com/_chulan' },
-          { icon: 'juejin', link: 'https://juejin.cn/user/3940246036158974' },
-          { icon: 'bilibili', link: 'https://space.bilibili.com/284237214' }
-        ]
+        socials:
+          - icon: github
+            link: https://github.com/wu-clan
+          - icon: x
+            link: https://twitter.com/_chulan
+          - icon: juejin
+            link: https://juejin.cn/user/3940246036158974
+          - icon: bilibili
+            link: https://space.bilibili.com/284237214
       - name: dowdawn
         link: https://blog.csdn.net/qq_42280510?type=blog
         avatar: https://avatars.githubusercontent.com/u/41266749?v=4
         desc: AI 全干工程狮
         location: 厦门，福建
         organization: FastAPI Practices
-        socials: [
-          { icon: 'github', link: 'https://github.com/downdawn' }
-        ]
+        socials:
+          - icon: github
+            link: https://github.com/downdawn
   - title: 名誉核心团队
     desc: 名誉核心团队成员在过去曾为项目做出过突出贡献，我们在此向他们致敬
     list:
@@ -37,19 +41,19 @@ groups:
         avatar: https://avatars.githubusercontent.com/u/63089130?v=4
         desc: 大数据运维吗喽，主要做监控、告警、平台分析以及运维开发等工作，略懂一些 Go 和 Python
         location: 成都，四川
-        organization: --
-        socials: [
-          { icon: 'github', link: 'https://github.com/Meepoljdx' }
-        ]
+        organization: '--'
+        socials:
+          - icon: github
+            link: https://github.com/Meepoljdx
       - name: Davidduang
         link: https://github.com/dividduang
         avatar: https://avatars.githubusercontent.com/u/110005582?v=4
         desc: 一个平平无奇的网管
         location: 深圳，广东
-        organization: --
-        socials: [
-          { icon: 'github', link: 'https://github.com/dividduang' }
-        ]
+        organization: '--'
+        socials:
+          - icon: github
+            link: https://github.com/dividduang
   - title: 社区伙伴
     desc: 社区成员让这里变得更加丰富多彩，有必要在此特别提及。我们与这些合作伙伴建立了更加亲密的关系，经常与他们就即将到来的功能和新闻展开协作
     list:
@@ -58,28 +62,29 @@ groups:
         avatar: https://avatars.githubusercontent.com/u/124766156?v=4
         desc: 运维开发工程师，开发语言 Python，目前开发能力不是很高，自己写一个运维平台
         location: 成都，四川
-        organization: --
-        socials: [
-          { icon: 'github', link: 'https://github.com/xiangshen123' }
-        ]
+        organization: '--'
+        socials:
+          - icon: github
+            link: https://github.com/xiangshen123
       - name: 陈安生（陈大锤）
         link: https://github.com/chenansheng
         avatar: https://avatars.githubusercontent.com/u/33371724?v=4
         desc: 国企 java 后端，深度学习开发选手
         location: 济南，山东
-        organization: --
-        socials: [
-          { icon: 'github', link: 'https://github.com/chenansheng' }
-        ]
+        organization: '--'
+        socials:
+          - icon: github
+            link: https://github.com/chenansheng
       - name: imba
         link: https://github.com/imbalich
         avatar: https://avatars.githubusercontent.com/u/49424658?v=4
         desc: 苦哈哈的全干工程师
         location: 西安，陕西
-        organization: --
-        socials: [
-          { icon: 'github', link: 'https://github.com/imbalich' }
-        ]
+        organization: '--'
+        socials:
+          - icon: github
+            link: https://github.com/imbalich
+permalink: /article/85vk4vsd/
 ---
 
 [申请 **加入团队**](./join.md){.read-more}

package.json

@@ -19,6 +19,7 @@
   "devDependencies": {
     "@vuepress/bundler-vite": "2.0.0-rc.24",
     "@vuepress/plugin-baidu-analytics": "2.0.0-rc.112",
+    "@vuepress/plugin-llms": "2.0.0-rc.112",
     "@vuepress/plugin-umami-analytics": "2.0.0-rc.112",
     "vue": "^3.5.18",
     "vuepress": "2.0.0-rc.24",