📝 docs: update docs (lobehub#1522)

* 📝 docs: update docs * 📝 docs: update docs * 📝 docs: update docs * 📝 docs: update docs * 📝 docs: update docs * 📝 docs: update docs * 📝 docs: update docs * 📝 docs: update docs * 📝 docs: update docs * 📝 docs: update docs * 📝 docs: update docs
hanwwh · Mar 10, 2024 · 40ffd72 · 40ffd72
1 parent 5a2bd5f
commit 40ffd72
Show file tree

Hide file tree

Showing 26 changed files with 198 additions and 4 deletions.
diff --git a/docs/self-hosting/environment-variables.mdx b/docs/self-hosting/environment-variables.mdx
@@ -0,0 +1,11 @@
+import { Cards } from 'nextra/components';
+
+# Environment Variables
+
+LobeChat provides some additional configuration options when deployed, which can be customized using environment variables.
+
+<Cards>
+  <Cards.Card href={'environment-variables/basic'} title={'Basic Environment Variables'} />
+
+  <Cards.Card href={'environment-variables/model-provider'} title={'Model Service Providers'} />
+</Cards>
diff --git a/docs/self-hosting/environment-variables.zh-CN.mdx b/docs/self-hosting/environment-variables.zh-CN.mdx
@@ -0,0 +1,10 @@
+import { Cards } from 'nextra/components';
+
+# 环境变量
+
+LobeChat 在部署时提供了一些额外的配置项，你可以使用环境变量进行自定义设置。
+
+<Cards>
+  <Cards.Card href={'environment-variables/basic'} title={'基础环境变量'} />
+  <Cards.Card href={'environment-variables/model-provider'} title={'模型服务商'} />
+</Cards>
diff --git a/docs/self-hosting/start.mdx b/docs/self-hosting/start.mdx
@@ -0,0 +1,17 @@
+# Build your own Lobe Chat
+
+Choose your favorite platform to get started.
+
+## Choose your deployment platform
+
+LobeChat support multiple deployment platforms, including Vercel, Docker, and Docker Compose and so on, you can choose the deployment platform that suits you.
+
+<PlatformCards
+  docker={'Docker'}
+  dockerCompose={'Docker Compose'}
+  netlify={'Netlify'}
+  repocloud={'RepoCloud'}
+  sealos={'SealOS'}
+  vercel={'Vercel'}
+  zeabur={'Zeabur'}
+/>
diff --git a/docs/self-hosting/start.zh-CN.mdx b/docs/self-hosting/start.zh-CN.mdx
@@ -0,0 +1,17 @@
+# 构建属于自己的 Lobe Chat
+
+选择自己喜爱的平台，构建属于自己的 Lobe Chat。
+
+## 选择部署平台
+
+LobeChat 支持多种部署平台，包括 Vercel、Docker 和 Docker Compose 等，你可以选择适合自己的部署平台进行部署。
+
+<PlatformCards
+  docker={'Docker 部署'}
+  dockerCompose={'Docker Compose 部署'}
+  netlify={'Netlify 部署'}
+  repocloud={'Repocloud 部署'}
+  sealos={'SealOS 部署'}
+  vercel={'Vercel 部署'}
+  zeabur={'Zeabur 部署'}
+/>
diff --git a/docs/usage/agents/model.mdx b/docs/usage/agents/model.mdx
@@ -1,3 +1,8 @@
+---
+title: LLM Guide
+description: Explore the capabilities of ChatGPT models from gpt-3.5-turbo to gpt-4-32k, understanding their speed, context limits, and cost. Learn about model parameters like temperature and top-p for better output.
+---
+
 import { Callout } from 'nextra/components';
 
 # Model Guide

diff --git a/docs/usage/features/agent-market.mdx b/docs/usage/features/agent-market.mdx
@@ -1,9 +1,13 @@
+---
+title: Assistant Market
+---
+
 import { Callout } from 'nextra/components';
 
-# Agent Market
+# Assistant Market
 
 <Image
-  alt={'Agent Market'}
+  alt={'Assistant Market'}
   src={
     'https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/268670869-f1ffbf66-42b6-42cf-a937-9ce1f8328514.png'
   }

diff --git a/docs/usage/features/local-llm.mdx b/docs/usage/features/local-llm.mdx
@@ -1,3 +1,8 @@
+---
+title: Local LLM
+image: https://github.com/lobehub/lobe-chat/assets/28616219/8292b22e-1f4f-478b-b510-32c7883c1c6d
+---
+
 import { Callout } from 'nextra/components';
 
 # Local Large Language Model (LLM) Support

diff --git a/docs/usage/features/local-llm.zh-CN.mdx b/docs/usage/features/local-llm.zh-CN.mdx
@@ -1,3 +1,10 @@
+---
+title: 本地大语言模型（Local）
+description: LobeChat 支持本地 LLM，使用 Ollama AI集成带来高效智能沟通。体验本地大语言模型的隐私性、安全性和即时交流
+image: https://github.com/lobehub/lobe-chat/assets/28616219/8292b22e-1f4f-478b-b510-32c7883c1c6d
+tags: 本地大语言模型,LLM,LobeChat v0.127.0,Ollama AI,Docker 部署
+---
+
 import { Callout } from 'nextra/components';
 
 # 支持本地大语言模型（LLM）

diff --git a/docs/usage/features/mobile.mdx b/docs/usage/features/mobile.mdx
@@ -1,3 +1,7 @@
+---
+title: Mobile Device Adaptation
+---
+
 # Mobile Device Adaptation
 
 <Image

diff --git a/docs/usage/features/multi-ai-providers.mdx b/docs/usage/features/multi-ai-providers.mdx
@@ -1,3 +1,7 @@
+---
+title: Multi AI Providers
+---
+
 import { Callout } from 'nextra/components';
 
 # Multi-Model Service Provider Support

diff --git a/docs/usage/features/plugin-system.mdx b/docs/usage/features/plugin-system.mdx
@@ -1,3 +1,7 @@
+---
+title: Plugin System
+---
+
 import { Callout, Steps } from 'nextra/components';
 
 # Plugin System

diff --git a/docs/usage/features/pwa.mdx b/docs/usage/features/pwa.mdx
@@ -1,3 +1,7 @@
+---
+title: Progressive Web Apps (PWA)
+---
+
 import { Steps } from 'nextra/components';
 
 # Progressive Web App (PWA)

diff --git a/docs/usage/features/text-to-image.mdx b/docs/usage/features/text-to-image.mdx
@@ -1,3 +1,7 @@
+---
+title: Text to Image
+---
+
 # Text to Image Generation
 
 <Image

diff --git a/docs/usage/features/theme.mdx b/docs/usage/features/theme.mdx
@@ -1,3 +1,7 @@
+---
+title: Custom Themes
+---
+
 import { Callout } from 'nextra/components';
 
 # Custom Themes

diff --git a/docs/usage/features/tts.mdx b/docs/usage/features/tts.mdx
@@ -1,3 +1,8 @@
+---
+title: Speech Synthesis and Recognition (TTS & STT)
+---
+
+
 import { Callout } from 'nextra/components';
 
 # TTS & STT Voice Conversation

diff --git a/docs/usage/features/vision.mdx b/docs/usage/features/vision.mdx
@@ -1,7 +1,12 @@
-# Model Visual Recognition
+---
+title: Vision Recognition
+---
+
+
+# Model Vision Recognition
 
 <Image
-  alt={'Model Visual Recognition'}
+  alt={'Model Vision Recognition'}
   src={
     'https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/284072129-382bdf30-e3d6-4411-b5a0-249710b8ba08.png'
   }

diff --git a/docs/usage/plugins/plugin-development.mdx → docs/usage/plugins/development.mdx b/docs/usage/plugins/plugin-development.mdx → docs/usage/plugins/development.mdx
diff --git a/...sage/plugins/plugin-development.zh-CN.mdx → docs/usage/plugins/development.zh-CN.mdx b/...sage/plugins/plugin-development.zh-CN.mdx → docs/usage/plugins/development.zh-CN.mdx
diff --git a/docs/usage/plugins/plugin-store.mdx → docs/usage/plugins/store.mdx b/docs/usage/plugins/plugin-store.mdx → docs/usage/plugins/store.mdx
diff --git a/docs/usage/plugins/plugin-store.zh-CN.mdx → docs/usage/plugins/store.zh-CN.mdx b/docs/usage/plugins/plugin-store.zh-CN.mdx → docs/usage/plugins/store.zh-CN.mdx
diff --git a/docs/usage/providers/ollama.mdx b/docs/usage/providers/ollama.mdx
@@ -1,3 +1,9 @@
+---
+title: Using Ollama in LobeChat
+image: https://github.com/lobehub/lobe-chat/assets/28616219/bb5b3611-3aa8-4ec7-a6dc-f35a13b34d81
+---
+
+
 import { Callout, Steps, Tabs } from 'nextra/components';
 
 # Using Ollama in LobeChat

diff --git a/docs/usage/providers/ollama.zh-CN.mdx b/docs/usage/providers/ollama.zh-CN.mdx
@@ -1,3 +1,8 @@
+---
+title: 在 LobeChat 中使用 Ollama
+image: https://github.com/lobehub/lobe-chat/assets/28616219/bb5b3611-3aa8-4ec7-a6dc-f35a13b34d81
+---
+
 import { Callout, Steps, Tabs } from 'nextra/components';
 
 # 在 LobeChat 中使用 Ollama

diff --git a/docs/usage/providers/ollama/gemma.mdx b/docs/usage/providers/ollama/gemma.mdx
@@ -1,3 +1,9 @@
+---
+title: Using Google Gemma Model
+image: https://github.com/lobehub/lobe-chat/assets/28616219/817f5655-4f9e-414b-af9f-9ccc5410a06d
+---
+
+
 import { Callout, Steps } from 'nextra/components';
 
 # Using Google Gemma Model

diff --git a/docs/usage/providers/ollama/gemma.zh-CN.mdx b/docs/usage/providers/ollama/gemma.zh-CN.mdx
@@ -1,3 +1,8 @@
+---
+title: 使用 Google Gemma 模型
+image: https://github.com/lobehub/lobe-chat/assets/28616219/817f5655-4f9e-414b-af9f-9ccc5410a06d
+---
+
 import { Callout, Steps } from 'nextra/components';
 
 # 使用 Google Gemma 模型

diff --git a/docs/usage/start.mdx b/docs/usage/start.mdx
@@ -0,0 +1,34 @@
+---
+title: Get Start
+image: https://github.com/lobehub/lobe-chat/assets/28616219/9be1a584-8b66-4bc4-ac96-14c4f94dc499
+---
+
+# ✨ Feature Overview
+
+<Image
+  alt={
+    'Vision Model / TTS & STT / Local LLMs / Multi AI Providers / Agent Market / Plugin System / Personal'
+  }
+  height={426}
+  margin={12}
+  src={'https://github.com/lobehub/lobe-chat/assets/28616219/8b04c3c9-3d71-4fb4-bd9b-a4f415c5876d'}
+  width={832}
+/>
+
+<FeatureCards
+  agentMarket={'Assistant Market'}
+  localLLM={'Local LLM'}
+  pluginSystem={'Plugin System'}
+  providers="Multi AI Providers"
+  textToImage={'Text-to-Image'}
+  tts={'TTS & STT'}
+  vision={'Visual Recognition'}
+/>
+
+## Experience Features
+
+<ExperienceCards
+  mobile={'Mobile Device Adaptation'}
+  theme={'Custom Themes'}
+  pwa={'Progressive Web App'}
+/>
diff --git a/docs/usage/start.zh-CN.mdx b/docs/usage/start.zh-CN.mdx
@@ -0,0 +1,28 @@
+---
+title: 开始使用
+image: https://github.com/lobehub/lobe-chat/assets/28616219/9be1a584-8b66-4bc4-ac96-14c4f94dc499
+---
+
+# ✨ LobeChat 功能特性一览
+
+<Image
+  alt={'视觉感知 / 语音会话 / 多 AI 服务商 / 本地LLM /  助手市场 / 插件系统 / 私人定制'}
+  height={426}
+  margin={12}
+  src={'https://github.com/lobehub/lobe-chat/assets/28616219/8b04c3c9-3d71-4fb4-bd9b-a4f415c5876d'}
+  width={832}
+/>
+
+<FeatureCards
+  agentMarket={'助手市场'}
+  localLLM={'本地大语言模型'}
+  pluginSystem={'插件系统'}
+  providers="多模型服务商"
+  textToImage={'文生图'}
+  tts={'TTS & STT'}
+  vision={'视觉识别'}
+/>
+
+## 体验特性
+
+<ExperienceCards mobile={'移动设备适配'} theme={'自定义主题'} pwa={'渐进式 Web 应用（PWA）'} />