feat: docs workflow
This commit is contained in:
Lan
@@ -6,7 +6,7 @@ on:
|
|||||||
# 在针对 `main` 分支的推送上运行。如果你
|
# 在针对 `main` 分支的推送上运行。如果你
|
||||||
# 使用 `master` 分支作为默认分支，请将其更改为 `master`
|
# 使用 `master` 分支作为默认分支，请将其更改为 `master`
|
||||||
push:
|
push:
|
||||||
branches: [master]
|
branches: [ master ]
|
||||||
|
|
||||||
# 允许你从 Actions 选项卡手动运行此工作流程
|
# 允许你从 Actions 选项卡手动运行此工作流程
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
@@ -32,21 +32,24 @@ jobs:
|
|||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0 # 如果未启用 lastUpdated，则不需要
|
fetch-depth: 0 # 如果未启用 lastUpdated，则不需要
|
||||||
# - uses: pnpm/action-setup@v3 # 如果使用 pnpm，请取消此区域注释
|
- uses: pnpm/action-setup@v3
|
||||||
# with:
|
with:
|
||||||
# version: 9
|
version: 9
|
||||||
# - uses: oven-sh/setup-bun@v1 # 如果使用 Bun，请取消注释
|
# - uses: oven-sh/setup-bun@v1 # 如果使用 Bun，请取消注释
|
||||||
- name: Setup Node
|
- name: Setup Node
|
||||||
uses: actions/setup-node@v4
|
uses: actions/setup-node@v4
|
||||||
with:
|
with:
|
||||||
node-version: 20
|
node-version: 20
|
||||||
cache: pnpm # 或 pnpm / yarn
|
cache: 'pnpm'
|
||||||
|
cache-dependency-path: 'docs/pnpm-lock.yaml'
|
||||||
- name: Setup Pages
|
- name: Setup Pages
|
||||||
uses: actions/configure-pages@v4
|
uses: actions/configure-pages@v4
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: pnpm install # 或 pnpm install / yarn install / bun install
|
working-directory: docs
|
||||||
|
run: pnpm install
|
||||||
- name: Build with VitePress
|
- name: Build with VitePress
|
||||||
run: pnpm run docs:build # 或 pnpm docs:build / yarn docs:build / bun run docs:build
|
working-directory: docs
|
||||||
|
run: pnpm run docs:build
|
||||||
- name: Upload artifact
|
- name: Upload artifact
|
||||||
uses: actions/upload-pages-artifact@v3
|
uses: actions/upload-pages-artifact@v3
|
||||||
with:
|
with:
|
||||||
|
|||||||
+222
-204
@@ -1,216 +1,234 @@
|
|||||||
import {defineConfig} from 'vitepress'
|
import { defineConfig } from 'vitepress'
|
||||||
|
|
||||||
// https://vitepress.dev/reference/site-config
|
// https://vitepress.dev/reference/site-config
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
title: 'FileCodeBox',
|
title: 'FileCodeBox',
|
||||||
description: '简单高效的文件分享工具',
|
description: '简单高效的文件分享工具',
|
||||||
lang: 'zh-CN',
|
base: '/FileCodeBox/',
|
||||||
lastUpdated: true,
|
lang: 'zh-CN',
|
||||||
locales: {
|
lastUpdated: true,
|
||||||
root: {
|
locales: {
|
||||||
label: '简体中文',
|
root: {
|
||||||
lang: 'zh-CN',
|
label: '简体中文',
|
||||||
title: 'FileCodeBox',
|
lang: 'zh-CN',
|
||||||
description: '匿名口令分享文本，文件',
|
title: 'FileCodeBox',
|
||||||
themeConfig: {
|
description: '匿名口令分享文本，文件',
|
||||||
logo: '/logo_small.png',
|
themeConfig: {
|
||||||
nav: [
|
logo: '/logo_small.png',
|
||||||
{text: '首页', link: '/'},
|
nav: [
|
||||||
{text: '指南', link: '/guide/getting-started'},
|
{ text: '首页', link: '/' },
|
||||||
{text: 'API', link: '/api/'},
|
{ text: '指南', link: '/guide/getting-started' },
|
||||||
{
|
{ text: 'API', link: '/api/' },
|
||||||
text: '了解更多',
|
{
|
||||||
items: [
|
text: '了解更多',
|
||||||
{text: '更新日志', link: '/changelog'},
|
items: [
|
||||||
{text: '贡献指南', link: '/contributing'},
|
{ text: '更新日志', link: '/changelog' },
|
||||||
],
|
{ text: '贡献指南', link: '/contributing' },
|
||||||
},
|
],
|
||||||
],
|
},
|
||||||
|
|
||||||
sidebar: {
|
|
||||||
'/guide/': [
|
|
||||||
{
|
|
||||||
text: '介绍',
|
|
||||||
items: [
|
|
||||||
{
|
|
||||||
text: '什么是 FileCodeBox',
|
|
||||||
link: '/guide/introduction',
|
|
||||||
},
|
|
||||||
{text: '快速开始', link: '/guide/getting-started'},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
text: '基础功能',
|
|
||||||
items: [
|
|
||||||
{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'},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
'/api/': [
|
|
||||||
{
|
|
||||||
text: 'API 参考',
|
|
||||||
items: [
|
|
||||||
{text: '分享接口', link: '/api/#分享接口'},
|
|
||||||
{text: '管理接口', link: '/api/#管理接口'},
|
|
||||||
{text: '错误响应', link: '/api/#错误响应'},
|
|
||||||
{text: '状态码说明', link: '/api/#状态码说明'},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
socialLinks: [
|
|
||||||
{icon: 'github', link: 'https://github.com/vastsa/FileCodeBox'},
|
|
||||||
],
|
|
||||||
footer: {
|
|
||||||
message: '基于 LGPL 许可发布',
|
|
||||||
copyright: 'Copyright © 2023-present FileCodeBox',
|
|
||||||
},
|
|
||||||
search: {
|
|
||||||
provider: 'local',
|
|
||||||
},
|
|
||||||
outline: {
|
|
||||||
level: [2, 3],
|
|
||||||
label: '目录',
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
en: {
|
|
||||||
label: 'English',
|
|
||||||
lang: 'en-US',
|
|
||||||
title: 'FileCodeBox',
|
|
||||||
description: 'Simple and efficient file sharing tool',
|
|
||||||
themeConfig: {
|
|
||||||
logo: '/logo_small.png',
|
|
||||||
nav: [
|
|
||||||
{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'},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
sidebar: {
|
|
||||||
'/en/guide/': [
|
|
||||||
{
|
|
||||||
text: 'Introduction',
|
|
||||||
items: [
|
|
||||||
{
|
|
||||||
text: 'What is FileCodeBox',
|
|
||||||
link: '/en/guide/introduction',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
text: 'Getting Started',
|
|
||||||
link: '/en/guide/getting-started',
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
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: 'Advanced Features',
|
|
||||||
items: [
|
|
||||||
{text: 'Storage Configuration', link: '/en/guide/storage'},
|
|
||||||
{text: 'Security Settings', link: '/en/guide/security'},
|
|
||||||
{
|
|
||||||
text: 'System Configuration',
|
|
||||||
link: '/en/guide/configuration',
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
'/en/api/': [
|
|
||||||
{
|
|
||||||
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'},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
socialLinks: [
|
|
||||||
{icon: 'github', link: 'https://github.com/vastsa/FileCodeBox'},
|
|
||||||
],
|
|
||||||
footer: {
|
|
||||||
message: '基于 MIT 许可发布',
|
|
||||||
copyright: 'Copyright © 2023-present FileCodeBox',
|
|
||||||
},
|
|
||||||
search: {
|
|
||||||
provider: 'local',
|
|
||||||
},
|
|
||||||
outline: {
|
|
||||||
level: [2, 3],
|
|
||||||
label: '目录',
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
|
|
||||||
themeConfig: {
|
|
||||||
// 语言切换器
|
|
||||||
langMenuLabel: '切换语言',
|
|
||||||
|
|
||||||
// 社交链接
|
|
||||||
socialLinks: [
|
|
||||||
{icon: 'github', link: 'https://github.com/vastsa/FileCodeBox'},
|
|
||||||
],
|
],
|
||||||
|
|
||||||
// 页脚
|
sidebar: {
|
||||||
footer: {
|
'/guide/': [
|
||||||
message: '基于 MIT 许可发布',
|
{
|
||||||
copyright: 'Copyright © 2023-present FileCodeBox',
|
text: '介绍',
|
||||||
},
|
items: [
|
||||||
|
{
|
||||||
// 搜索
|
text: '什么是 FileCodeBox',
|
||||||
search: {
|
link: '/guide/introduction',
|
||||||
provider: 'local',
|
|
||||||
options: {
|
|
||||||
locales: {
|
|
||||||
zh: {
|
|
||||||
translations: {
|
|
||||||
button: {
|
|
||||||
buttonText: '搜索文档',
|
|
||||||
buttonAriaLabel: '搜索文档',
|
|
||||||
},
|
|
||||||
modal: {
|
|
||||||
noResultsText: '无法找到相关结果',
|
|
||||||
resetButtonTitle: '清除查询条件',
|
|
||||||
footer: {
|
|
||||||
selectText: '选择',
|
|
||||||
navigateText: '切换',
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
},
|
||||||
|
{ text: '快速开始', link: '/guide/getting-started' },
|
||||||
|
],
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
text: '基础功能',
|
||||||
|
items: [
|
||||||
|
{ 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' },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
'/api/': [
|
||||||
|
{
|
||||||
|
text: 'API 参考',
|
||||||
|
items: [
|
||||||
|
{ text: '分享接口', link: '/api/#分享接口' },
|
||||||
|
{ text: '管理接口', link: '/api/#管理接口' },
|
||||||
|
{ text: '错误响应', link: '/api/#错误响应' },
|
||||||
|
{ text: '状态码说明', link: '/api/#状态码说明' },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
socialLinks: [
|
||||||
|
{ icon: 'github', link: 'https://github.com/vastsa/FileCodeBox' },
|
||||||
|
],
|
||||||
|
footer: {
|
||||||
|
message: '基于 MIT 许可发布',
|
||||||
|
copyright: 'Copyright © 2023-present FileCodeBox',
|
||||||
|
},
|
||||||
|
search: {
|
||||||
|
provider: 'local',
|
||||||
},
|
},
|
||||||
|
|
||||||
outline: {
|
outline: {
|
||||||
level: [2, 3],
|
level: [2, 3],
|
||||||
label: '目录',
|
label: '目录',
|
||||||
},
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
|
en: {
|
||||||
|
label: 'English',
|
||||||
|
lang: 'en-US',
|
||||||
|
title: 'FileCodeBox',
|
||||||
|
description: 'Simple and efficient file sharing tool',
|
||||||
|
themeConfig: {
|
||||||
|
logo: '/logo_small.png',
|
||||||
|
nav: [
|
||||||
|
{ 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' },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
|
||||||
|
sidebar: {
|
||||||
|
'/en/guide/': [
|
||||||
|
{
|
||||||
|
text: 'Introduction',
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
text: 'What is FileCodeBox',
|
||||||
|
link: '/en/guide/introduction',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: 'Getting Started',
|
||||||
|
link: '/en/guide/getting-started',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
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: 'Advanced Features',
|
||||||
|
items: [
|
||||||
|
{ text: 'Storage Configuration', link: '/en/guide/storage' },
|
||||||
|
{ text: 'Security Settings', link: '/en/guide/security' },
|
||||||
|
{
|
||||||
|
text: 'System Configuration',
|
||||||
|
link: '/en/guide/configuration',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
'/en/api/': [
|
||||||
|
{
|
||||||
|
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' },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
socialLinks: [
|
||||||
|
{ icon: 'github', link: 'https://github.com/vastsa/FileCodeBox' },
|
||||||
|
],
|
||||||
|
footer: {
|
||||||
|
message: 'Released under the MIT License',
|
||||||
|
copyright: 'Copyright © 2023-present FileCodeBox',
|
||||||
|
},
|
||||||
|
search: {
|
||||||
|
provider: 'local',
|
||||||
|
},
|
||||||
|
outline: {
|
||||||
|
level: [2, 3],
|
||||||
|
label: '目录',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
|
||||||
|
themeConfig: {
|
||||||
|
// 语言切换器
|
||||||
|
langMenuLabel: '切换语言',
|
||||||
|
|
||||||
|
// 社交链接
|
||||||
|
socialLinks: [
|
||||||
|
{ icon: 'github', link: 'https://github.com/vastsa/FileCodeBox' },
|
||||||
|
],
|
||||||
|
|
||||||
|
// 页脚
|
||||||
|
footer: {
|
||||||
|
message: '基于 MIT 许可发布',
|
||||||
|
copyright: 'Copyright © 2023-present FileCodeBox',
|
||||||
|
},
|
||||||
|
|
||||||
|
// 搜索
|
||||||
|
search: {
|
||||||
|
provider: 'local',
|
||||||
|
options: {
|
||||||
|
locales: {
|
||||||
|
zh: {
|
||||||
|
translations: {
|
||||||
|
button: {
|
||||||
|
buttonText: '搜索文档',
|
||||||
|
buttonAriaLabel: '搜索文档',
|
||||||
|
},
|
||||||
|
modal: {
|
||||||
|
noResultsText: '无法找到相关结果',
|
||||||
|
resetButtonTitle: '清除查询条件',
|
||||||
|
footer: {
|
||||||
|
selectText: '选择',
|
||||||
|
navigateText: '切换',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
en: {
|
||||||
|
translations: {
|
||||||
|
button: {
|
||||||
|
buttonText: 'Search',
|
||||||
|
buttonAriaLabel: 'Search docs',
|
||||||
|
},
|
||||||
|
modal: {
|
||||||
|
noResultsText: 'No results found',
|
||||||
|
resetButtonTitle: 'Clear query',
|
||||||
|
footer: {
|
||||||
|
selectText: 'to select',
|
||||||
|
navigateText: 'to navigate',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
|
||||||
|
outline: {
|
||||||
|
level: [2, 3],
|
||||||
|
label: '目录',
|
||||||
|
},
|
||||||
|
},
|
||||||
})
|
})
|
||||||
|
|||||||
Reference in New Issue
Block a user