orion/filecodebox
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: docs

Browse Source
This commit is contained in:
Lan
2025-02-12 14:16:07 +08:00
parent 4f0df03691
commit d1f10a33fb
2 changed files with 221 additions and 207 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Dockerfile
+17 -4
View File
@@ -1,11 +1,24 @@
FROM python:3.9.5-slim-buster
LABEL author="Lan"
LABEL email="vast@tom.com"
LABEL email="xzu@live.com"
# 将当前目录下的文件复制到容器的 /app 目录
COPY . /app
RUN ln -sf /usr/share/zoneinfo/Asia/Shanghai /etc/localtime
RUN echo 'Asia/Shanghai' >/etc/timezone
# 设置时区为亚洲/上海
RUN ln -sf /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && echo 'Asia/Shanghai' >/etc/timezone
# 设置工作目录
WORKDIR /app
# 删除不必要的目录，减少镜像体积
RUN rm -rf docs fcb-fronted
# 安装依赖
RUN pip install -r requirements.txt
# 暴露端口
EXPOSE 12345
CMD ["python","main.py"]
# 启动应用
CMD ["python", "main.py"]
docs/.vitepress/config.mts
+35 -34
View File
@@ -1,10 +1,11 @@
import { defineConfig } from 'vitepress'
import {defineConfig} from 'vitepress'
// https://vitepress.dev/reference/site-config
export default defineConfig({
title: 'FileCodeBox',
description: '简单高效的文件分享工具',
lang: 'zh-CN',
base: 'FileCodeBox',
lastUpdated: true,
locales: {
root: {
@@ -15,14 +16,14 @@ export default defineConfig({
themeConfig: {
logo: '/logo_small.png',
nav: [
{ text: '首页', link: '/' },
{ text: '指南', link: '/guide/getting-started' },
{ text: 'API', link: '/api/' },
{text: '首页', link: '/'},
{text: '指南', link: '/guide/getting-started'},
{text: 'API', link: '/api/'},
{
text: '了解更多',
items: [
{ text: '更新日志', link: '/changelog' },
{ text: '贡献指南', link: '/contributing' },
{text: '更新日志', link: '/changelog'},
{text: '贡献指南', link: '/contributing'},
],
},
],
@@ -36,23 +37,23 @@ export default defineConfig({
text: '什么是 FileCodeBox',
link: '/guide/introduction',
},
{ text: '快速开始', link: '/guide/getting-started' },
{text: '快速开始', link: '/guide/getting-started'},
],
},
{
text: '基础功能',
items: [
{ text: '文件上传', link: '/guide/upload' },
{ text: '文件分享', link: '/guide/share' },
{ text: '文件管理', link: '/guide/management' },
{text: '文件上传', link: '/guide/upload'},
{text: '文件分享', link: '/guide/share'},
{text: '文件管理', link: '/guide/management'},
],
},
{
text: '高级特性',
items: [
{ text: '存储配置', link: '/guide/storage' },
{ text: '安全设置', link: '/guide/security' },
{ text: '系统配置', link: '/guide/configuration' },
{text: '存储配置', link: '/guide/storage'},
{text: '安全设置', link: '/guide/security'},
{text: '系统配置', link: '/guide/configuration'},
],
},
],
@@ -60,16 +61,16 @@ export default defineConfig({
{
text: 'API 参考',
items: [
{ text: '分享接口', link: '/api/#分享接口' },
{ text: '管理接口', link: '/api/#管理接口' },
{ text: '错误响应', link: '/api/#错误响应' },
{ text: '状态码说明', link: '/api/#状态码说明' },
{text: '分享接口', link: '/api/#分享接口'},
{text: '管理接口', link: '/api/#管理接口'},
{text: '错误响应', link: '/api/#错误响应'},
{text: '状态码说明', link: '/api/#状态码说明'},
],
},
],
},
socialLinks: [
{ icon: 'github', link: 'https://github.com/vastsa/FileCodeBox' },
{icon: 'github', link: 'https://github.com/vastsa/FileCodeBox'},
],
footer: {
message: '基于 LGPL 许可发布',
@@ -92,14 +93,14 @@ export default defineConfig({
themeConfig: {
logo: '/logo_small.png',
nav: [
{ text: 'Home', link: '/en/' },
{ text: 'Guide', link: '/en/guide/getting-started' },
{ text: 'API', link: '/en/api/' },
{text: 'Home', link: '/en/'},
{text: 'Guide', link: '/en/guide/getting-started'},
{text: 'API', link: '/en/api/'},
{
text: 'More',
items: [
{ text: 'Changelog', link: '/en/changelog' },
{ text: 'Contributing', link: '/en/contributing' },
{text: 'Changelog', link: '/en/changelog'},
{text: 'Contributing', link: '/en/contributing'},
],
},
],
@@ -121,16 +122,16 @@ export default defineConfig({
{
text: 'Basic Features',
items: [
{ text: 'File Upload', link: '/en/guide/upload' },
{ text: 'File Sharing', link: '/en/guide/share' },
{ text: 'File Management', link: '/en/guide/management' },
{text: 'File Upload', link: '/en/guide/upload'},
{text: 'File Sharing', link: '/en/guide/share'},
{text: 'File Management', link: '/en/guide/management'},
],
},
{
text: 'Advanced Features',
items: [
{ text: 'Storage Configuration', link: '/en/guide/storage' },
{ text: 'Security Settings', link: '/en/guide/security' },
{text: 'Storage Configuration', link: '/en/guide/storage'},
{text: 'Security Settings', link: '/en/guide/security'},
{
text: 'System Configuration',
link: '/en/guide/configuration',
@@ -142,16 +143,16 @@ export default defineConfig({
{
text: 'API Reference',
items: [
{ text: 'Share API', link: '/en/api/#share-api' },
{ text: 'Admin API', link: '/en/api/#admin-api' },
{ text: 'Error Response', link: '/en/api/#error-response' },
{ text: 'Status Codes', link: '/en/api/#status-codes' },
{text: 'Share API', link: '/en/api/#share-api'},
{text: 'Admin API', link: '/en/api/#admin-api'},
{text: 'Error Response', link: '/en/api/#error-response'},
{text: 'Status Codes', link: '/en/api/#status-codes'},
],
},
],
},
socialLinks: [
{ icon: 'github', link: 'https://github.com/vastsa/FileCodeBox' },
{icon: 'github', link: 'https://github.com/vastsa/FileCodeBox'},
],
footer: {
message: '基于 MIT 许可发布',
@@ -174,7 +175,7 @@ export default defineConfig({
// 社交链接
socialLinks: [
{ icon: 'github', link: 'https://github.com/vastsa/FileCodeBox' },
{icon: 'github', link: 'https://github.com/vastsa/FileCodeBox'},
],
// 页脚