Skip to content

Commit 40ffd72

Browse files
authored
📝 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
1 parent 5a2bd5f commit 40ffd72

26 files changed

+198
-4
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import { Cards } from 'nextra/components';
2+
3+
# Environment Variables
4+
5+
LobeChat provides some additional configuration options when deployed, which can be customized using environment variables.
6+
7+
<Cards>
8+
<Cards.Card href={'environment-variables/basic'} title={'Basic Environment Variables'} />
9+
10+
<Cards.Card href={'environment-variables/model-provider'} title={'Model Service Providers'} />
11+
</Cards>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
import { Cards } from 'nextra/components';
2+
3+
# 环境变量
4+
5+
LobeChat 在部署时提供了一些额外的配置项,你可以使用环境变量进行自定义设置。
6+
7+
<Cards>
8+
<Cards.Card href={'environment-variables/basic'} title={'基础环境变量'} />
9+
<Cards.Card href={'environment-variables/model-provider'} title={'模型服务商'} />
10+
</Cards>

docs/self-hosting/start.mdx

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Build your own Lobe Chat
2+
3+
Choose your favorite platform to get started.
4+
5+
## Choose your deployment platform
6+
7+
LobeChat support multiple deployment platforms, including Vercel, Docker, and Docker Compose and so on, you can choose the deployment platform that suits you.
8+
9+
<PlatformCards
10+
docker={'Docker'}
11+
dockerCompose={'Docker Compose'}
12+
netlify={'Netlify'}
13+
repocloud={'RepoCloud'}
14+
sealos={'SealOS'}
15+
vercel={'Vercel'}
16+
zeabur={'Zeabur'}
17+
/>

docs/self-hosting/start.zh-CN.mdx

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# 构建属于自己的 Lobe Chat
2+
3+
选择自己喜爱的平台,构建属于自己的 Lobe Chat。
4+
5+
## 选择部署平台
6+
7+
LobeChat 支持多种部署平台,包括 Vercel、Docker 和 Docker Compose 等,你可以选择适合自己的部署平台进行部署。
8+
9+
<PlatformCards
10+
docker={'Docker 部署'}
11+
dockerCompose={'Docker Compose 部署'}
12+
netlify={'Netlify 部署'}
13+
repocloud={'Repocloud 部署'}
14+
sealos={'SealOS 部署'}
15+
vercel={'Vercel 部署'}
16+
zeabur={'Zeabur 部署'}
17+
/>

docs/usage/agents/model.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: LLM Guide
3+
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.
4+
---
5+
16
import { Callout } from 'nextra/components';
27

38
# Model Guide

docs/usage/features/agent-market.mdx

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1+
---
2+
title: Assistant Market
3+
---
4+
15
import { Callout } from 'nextra/components';
26

3-
# Agent Market
7+
# Assistant Market
48

59
<Image
6-
alt={'Agent Market'}
10+
alt={'Assistant Market'}
711
src={
812
'https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/268670869-f1ffbf66-42b6-42cf-a937-9ce1f8328514.png'
913
}

docs/usage/features/local-llm.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Local LLM
3+
image: https://github.com/lobehub/lobe-chat/assets/28616219/8292b22e-1f4f-478b-b510-32c7883c1c6d
4+
---
5+
16
import { Callout } from 'nextra/components';
27

38
# Local Large Language Model (LLM) Support

docs/usage/features/local-llm.zh-CN.mdx

+7
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: 本地大语言模型(Local)
3+
description: LobeChat 支持本地 LLM,使用 Ollama AI集成带来高效智能沟通。体验本地大语言模型的隐私性、安全性和即时交流
4+
image: https://github.com/lobehub/lobe-chat/assets/28616219/8292b22e-1f4f-478b-b510-32c7883c1c6d
5+
tags: 本地大语言模型,LLM,LobeChat v0.127.0,Ollama AI,Docker 部署
6+
---
7+
18
import { Callout } from 'nextra/components';
29

310
# 支持本地大语言模型(LLM)

docs/usage/features/mobile.mdx

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Mobile Device Adaptation
3+
---
4+
15
# Mobile Device Adaptation
26

37
<Image

docs/usage/features/multi-ai-providers.mdx

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Multi AI Providers
3+
---
4+
15
import { Callout } from 'nextra/components';
26

37
# Multi-Model Service Provider Support

docs/usage/features/plugin-system.mdx

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Plugin System
3+
---
4+
15
import { Callout, Steps } from 'nextra/components';
26

37
# Plugin System

docs/usage/features/pwa.mdx

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Progressive Web Apps (PWA)
3+
---
4+
15
import { Steps } from 'nextra/components';
26

37
# Progressive Web App (PWA)

docs/usage/features/text-to-image.mdx

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Text to Image
3+
---
4+
15
# Text to Image Generation
26

37
<Image

docs/usage/features/theme.mdx

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Custom Themes
3+
---
4+
15
import { Callout } from 'nextra/components';
26

37
# Custom Themes

docs/usage/features/tts.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Speech Synthesis and Recognition (TTS & STT)
3+
---
4+
5+
16
import { Callout } from 'nextra/components';
27

38
# TTS & STT Voice Conversation

docs/usage/features/vision.mdx

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
1-
# Model Visual Recognition
1+
---
2+
title: Vision Recognition
3+
---
4+
5+
6+
# Model Vision Recognition
27

38
<Image
4-
alt={'Model Visual Recognition'}
9+
alt={'Model Vision Recognition'}
510
src={
611
'https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/284072129-382bdf30-e3d6-4411-b5a0-249710b8ba08.png'
712
}
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/usage/providers/ollama.mdx

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Using Ollama in LobeChat
3+
image: https://github.com/lobehub/lobe-chat/assets/28616219/bb5b3611-3aa8-4ec7-a6dc-f35a13b34d81
4+
---
5+
6+
17
import { Callout, Steps, Tabs } from 'nextra/components';
28

39
# Using Ollama in LobeChat

docs/usage/providers/ollama.zh-CN.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: 在 LobeChat 中使用 Ollama
3+
image: https://github.com/lobehub/lobe-chat/assets/28616219/bb5b3611-3aa8-4ec7-a6dc-f35a13b34d81
4+
---
5+
16
import { Callout, Steps, Tabs } from 'nextra/components';
27

38
# 在 LobeChat 中使用 Ollama

docs/usage/providers/ollama/gemma.mdx

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Using Google Gemma Model
3+
image: https://github.com/lobehub/lobe-chat/assets/28616219/817f5655-4f9e-414b-af9f-9ccc5410a06d
4+
---
5+
6+
17
import { Callout, Steps } from 'nextra/components';
28

39
# Using Google Gemma Model

docs/usage/providers/ollama/gemma.zh-CN.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: 使用 Google Gemma 模型
3+
image: https://github.com/lobehub/lobe-chat/assets/28616219/817f5655-4f9e-414b-af9f-9ccc5410a06d
4+
---
5+
16
import { Callout, Steps } from 'nextra/components';
27

38
# 使用 Google Gemma 模型

docs/usage/start.mdx

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Get Start
3+
image: https://github.com/lobehub/lobe-chat/assets/28616219/9be1a584-8b66-4bc4-ac96-14c4f94dc499
4+
---
5+
6+
# ✨ Feature Overview
7+
8+
<Image
9+
alt={
10+
'Vision Model / TTS & STT / Local LLMs / Multi AI Providers / Agent Market / Plugin System / Personal'
11+
}
12+
height={426}
13+
margin={12}
14+
src={'https://github.com/lobehub/lobe-chat/assets/28616219/8b04c3c9-3d71-4fb4-bd9b-a4f415c5876d'}
15+
width={832}
16+
/>
17+
18+
<FeatureCards
19+
agentMarket={'Assistant Market'}
20+
localLLM={'Local LLM'}
21+
pluginSystem={'Plugin System'}
22+
providers="Multi AI Providers"
23+
textToImage={'Text-to-Image'}
24+
tts={'TTS & STT'}
25+
vision={'Visual Recognition'}
26+
/>
27+
28+
## Experience Features
29+
30+
<ExperienceCards
31+
mobile={'Mobile Device Adaptation'}
32+
theme={'Custom Themes'}
33+
pwa={'Progressive Web App'}
34+
/>

docs/usage/start.zh-CN.mdx

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: 开始使用
3+
image: https://github.com/lobehub/lobe-chat/assets/28616219/9be1a584-8b66-4bc4-ac96-14c4f94dc499
4+
---
5+
6+
# ✨ LobeChat 功能特性一览
7+
8+
<Image
9+
alt={'视觉感知 / 语音会话 / 多 AI 服务商 / 本地LLM / 助手市场 / 插件系统 / 私人定制'}
10+
height={426}
11+
margin={12}
12+
src={'https://github.com/lobehub/lobe-chat/assets/28616219/8b04c3c9-3d71-4fb4-bd9b-a4f415c5876d'}
13+
width={832}
14+
/>
15+
16+
<FeatureCards
17+
agentMarket={'助手市场'}
18+
localLLM={'本地大语言模型'}
19+
pluginSystem={'插件系统'}
20+
providers="多模型服务商"
21+
textToImage={'文生图'}
22+
tts={'TTS & STT'}
23+
vision={'视觉识别'}
24+
/>
25+
26+
## 体验特性
27+
28+
<ExperienceCards mobile={'移动设备适配'} theme={'自定义主题'} pwa={'渐进式 Web 应用(PWA)'} />

0 commit comments

Comments
 (0)