diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts index 50744733c4..f4e80efd3e 100644 --- a/docs/.vuepress/config.ts +++ b/docs/.vuepress/config.ts @@ -1,15 +1,14 @@ import { defineUserConfig } from 'vuepress'; -import Theme from './theme.config'; +import Theme from './theme'; import SearchPlugin from './plugins/search'; -import SitemapPlugin from './plugins/sitemap'; export default defineUserConfig({ base: '/docs/', lang: "zh-CN", title: "MaaAssistantArknights", description: "MAA", - theme: Theme, port: 3001, + locales: { '/': { lang: 'zh-CN', @@ -32,15 +31,16 @@ export default defineUserConfig({ description: '문서' } }, + markdown: { headers: { level: [2, 3, 4, 5], }, }, + + theme: Theme, + plugins: [ - SitemapPlugin(), - SearchPlugin() + SearchPlugin(), ], - temp: '.vuepress/.temp', - cache: '.vuepress/.cache' }); diff --git a/docs/.vuepress/navbar/en-us.ts b/docs/.vuepress/navbar/en-us.ts new file mode 100644 index 0000000000..58beb8021b --- /dev/null +++ b/docs/.vuepress/navbar/en-us.ts @@ -0,0 +1,29 @@ +import { navbar } from "vuepress-theme-hope"; + +export const enusNavbar = navbar([ + { + text: "Home", + icon: "ic:round-home", + link: "/en-us/", + }, + { + text: "User Manual", + icon: "mdi:user", + link: "/en-us/1.1-USER_MANUAL", + }, + { + text: "Development Docs", + icon: "ph:code-bold", + link: "/en-us/2.1-LINUX_TUTORIAL", + }, + { + text: "Protocol Docs", + icon: "basil:document-solid", + link: "/en-us/3.1-INTEGRATION", + }, + { + text: "MAA Website", + icon: "mdi:cow", + link: "https://maa.plus", + }, +]); diff --git a/docs/.vuepress/navbar/index.ts b/docs/.vuepress/navbar/index.ts new file mode 100644 index 0000000000..5e1586782d --- /dev/null +++ b/docs/.vuepress/navbar/index.ts @@ -0,0 +1,5 @@ +export * from "./zh-cn"; +export * from "./zh-tw"; +export * from "./en-us"; +export * from "./ja-jp"; +export * from "./ko-kr"; \ No newline at end of file diff --git a/docs/.vuepress/navbar/ja-jp.ts b/docs/.vuepress/navbar/ja-jp.ts new file mode 100644 index 0000000000..b39c4033f4 --- /dev/null +++ b/docs/.vuepress/navbar/ja-jp.ts @@ -0,0 +1,29 @@ +import { navbar } from "vuepress-theme-hope"; + +export const jajpNavbar = navbar([ + { + text: "主页", + icon: "ic:round-home", + link: "/ja-jp/", + }, + { + text: "使用説明", + icon: "mdi:user", + link: "/ja-jp/1.1-詳細説明", + }, + { + text: "開発関連", + icon: "ph:code-bold", + link: "/ja-jp/2.1-Linuxチュートリアル", + }, + { + text: "プロトコルドキュメント", + icon: "basil:document-solid", + link: "/ja-jp/3.1-統合ドキュメント", + }, + { + text: "MAA 公式サイト", + icon: "mdi:cow", + link: "https://maa.plus", + }, +]); diff --git a/docs/.vuepress/navbar/ko-kr.ts b/docs/.vuepress/navbar/ko-kr.ts new file mode 100644 index 0000000000..dfe9e73d9e --- /dev/null +++ b/docs/.vuepress/navbar/ko-kr.ts @@ -0,0 +1,29 @@ +import { navbar } from "vuepress-theme-hope"; + +export const kokrNavbar = navbar([ + { + text: "主页", + icon: "ic:round-home", + link: "/ko-kr/", + }, + { + text: "사용자 설명서", + icon: "mdi:user", + link: "/ko-kr/1.1-사용자_설명서", + }, + { + text: "개발 관련", + icon: "ph:code-bold", + link: "/ko-kr/2.1-LINUX_튜토리얼", + }, + { + text: "프로토콜 문서", + icon: "basil:document-solid", + link: "/ko-kr/3.1-연동", + }, + { + text: "MAA 공식 홈페이지", + icon: "mdi:cow", + link: "https://maa.plus", + }, +]); diff --git a/docs/.vuepress/navbar/zh-cn.ts b/docs/.vuepress/navbar/zh-cn.ts new file mode 100644 index 0000000000..bac8c5a373 --- /dev/null +++ b/docs/.vuepress/navbar/zh-cn.ts @@ -0,0 +1,29 @@ +import { navbar } from "vuepress-theme-hope"; + +export const zhcnNavbar = navbar([ + { + text: "主页", + icon: "ic:round-home", + link: "/", + }, + { + text: "用户手册", + icon: "mdi:user", + link: "/1.1-详细介绍", + }, + { + text: "开发文档", + icon: "ph:code-bold", + link: "/2.1-Linux编译教程", + }, + { + text: "协议文档", + icon: "basil:document-solid", + link: "/3.1-集成文档", + }, + { + text: "MAA 官网", + icon: "mdi:cow", + link: "https://maa.plus", + }, +]); diff --git a/docs/.vuepress/navbar/zh-tw.ts b/docs/.vuepress/navbar/zh-tw.ts new file mode 100644 index 0000000000..ec47439863 --- /dev/null +++ b/docs/.vuepress/navbar/zh-tw.ts @@ -0,0 +1,29 @@ +import { navbar } from "vuepress-theme-hope"; + +export const zhtwNavbar = navbar([ + { + text: "主页", + icon: "ic:round-home", + link: "/zh-tw/", + }, + { + text: "用户手册", + icon: "mdi:user", + link: "/zh-tw/1.1-詳細介紹", + }, + { + text: "開發文檔", + icon: "ph:code-bold", + link: "/zh-tw/2.1-Linux編譯教程", + }, + { + text: "協定文檔", + icon: "basil:document-solid", + link: "/zh-tw/3.1-集成文件", + }, + { + text: "MAA 官網", + icon: "mdi:cow", + link: "https://maa.plus", + }, +]); diff --git a/docs/.vuepress/plugins/sitemap.ts b/docs/.vuepress/plugins/sitemap.ts deleted file mode 100644 index 6d84e97712..0000000000 --- a/docs/.vuepress/plugins/sitemap.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { sitemapPlugin } from "vuepress-plugin-sitemap2"; - -export default function SitemapPlugin() { - return sitemapPlugin({ - hostname: "https://maa.plus", - }); -} diff --git a/docs/.vuepress/sidebar/en-us.ts b/docs/.vuepress/sidebar/en-us.ts new file mode 100644 index 0000000000..109bc281fe --- /dev/null +++ b/docs/.vuepress/sidebar/en-us.ts @@ -0,0 +1,124 @@ +import { sidebar } from "vuepress-theme-hope"; + +export const enusSidebar = sidebar({ + "/en-us/": [ + { + text: "MAA", + icon: "ic:round-home", + link: "/en-us/", + }, + { + text: "User Manual", + icon: "mdi:user", + collapsible: true, + children: [ + { + text: "Introduction", + icon: "mdi:information-outline", + link: "/en-us/1.1-USER_MANUAL", + }, + { + text: "FAQs", + icon: "ph:question-fill", + link: "/en-us/1.2-FAQ", + }, + { + text: "Emulator Supports", + icon: "mingcute:laptop-fill", + collapsible: true, + children: [ + { + text: "Windows", + icon: "ri:windows-fill", + link: "/en-us/1.3-EMULATOR_SUPPORTS", + }, + { + text: "Mac", + icon: "basil:apple-solid", + link: "/en-us/1.4-EMULATOR_SUPPORTS_FOR_MAC", + }, + { + text: "Linux", + icon: "teenyicons:linux-alt-solid", + link: "/en-us/1.5-EMULATOR_SUPPORTS_FOR_LINUX", + }, + ], + }, + ], + }, + { + text: "Development Docs", + icon: "ph:code-bold", + collapsible: true, + children: [ + { + text: "Linux Compilation Tutorial", + icon: "teenyicons:linux-alt-solid", + link: "/en-us/2.1-LINUX_TUTORIAL", + }, + { + text: "Development", + icon: "iconoir:developer", + link: "/en-us/2.2-DEVELOPMENT", + }, + { + text: "IssueBot Usage", + icon: "bxs:bot", + link: "/en-us/2.3-ISSUE_BOT_USAGE", + }, + { + text: "Web PR Tutorial", + icon: "mingcute:git-pull-request-fill", + link: "/en-us/2.4-PURE_WEB_PR_TUTORIAL", + }, + { + text: "Overseas Clients Adaptation", + icon: "ri:earth-fill", + link: "/en-us/2.5-OVERSEAS_CLIENTS_ADAPTATION", + }, + ], + }, + { + text: "Protocol Docs", + icon: "basil:document-solid", + collapsible: true, + children: [ + { + text: "Integration", + icon: "bxs:book", + link: "/en-us/3.1-INTEGRATION", + }, + { + text: "Callback Schema", + icon: "material-symbols:u-turn-left", + link: "/en-us/3.2-CALLBACK_SCHEMA", + }, + { + text: "Copilot Schema", + icon: "ph:sword-bold", + link: "/en-us/3.3-COPILOT_SCHEMA", + }, + { + text: "Task Schema", + icon: "material-symbols:task", + link: "/en-us/3.4-TASK_SCHEMA", + }, + { + text: "Integrated Strategy Schema", + icon: "ri:game-fill", + link: "/en-us/3.5-INTEGRATED_STRATEGY_SCHEMA", + }, + { + text: "Infrastructure Scheduling Schema", + icon: "material-symbols:view-quilt-rounded", + link: "/en-us/3.6-INFRASTRUCTURE_SCHEDULING_SCHEMA", + }, + { + text: "Security Presence Schema", + icon: "game-icons:prisoner", + link: "/en-us/3.7-SECURITY_PRESENCE_SCHEMA", + }, + ], + }, + ], +}); diff --git a/docs/.vuepress/sidebar/index.ts b/docs/.vuepress/sidebar/index.ts new file mode 100644 index 0000000000..5e1586782d --- /dev/null +++ b/docs/.vuepress/sidebar/index.ts @@ -0,0 +1,5 @@ +export * from "./zh-cn"; +export * from "./zh-tw"; +export * from "./en-us"; +export * from "./ja-jp"; +export * from "./ko-kr"; \ No newline at end of file diff --git a/docs/.vuepress/sidebar/ja-jp.ts b/docs/.vuepress/sidebar/ja-jp.ts new file mode 100644 index 0000000000..a2a3143e07 --- /dev/null +++ b/docs/.vuepress/sidebar/ja-jp.ts @@ -0,0 +1,107 @@ +import { sidebar } from "vuepress-theme-hope"; + +export const jajpSidebar = sidebar({ + "/ja-jp/": [ + { + text: "MAA", + icon: "ic:round-home", + link: "/ja-jp/", + }, + { + text: "使用説明", + icon: "mdi:user", + collapsible: true, + children: [ + { + text: "詳細説明", + icon: "mdi:information-outline", + link: "/ja-jp/1.1-詳細説明", + }, + { + text: "よくある質問", + icon: "ph:question-fill", + link: "/ja-jp/1.2-よくある質問", + }, + { + text: "エミュレータのサポート", + icon: "mingcute:laptop-fill", + link: "/ja-jp/1.3-エミュレータのサポート", + }, + ], + }, + { + text: "開発関連", + icon: "ph:code-bold", + collapsible: true, + children: [ + { + text: "Linuxコンパイルチュートリアル", + icon: "teenyicons:linux-alt-solid", + link: "/ja-jp/2.1-Linuxチュートリアル", + }, + { + text: "開発関連", + icon: "iconoir:developer", + link: "/ja-jp/2.2-プルリクエスト", + }, + { + text: "IssueBotの使用方法", + icon: "bxs:bot", + link: "/ja-jp/2.3-IssueBotの使用方法", + }, + { + text: "純WebサイトのPRチュートリアル", + icon: "mingcute:git-pull-request-fill", + link: "/ja-jp/2.4-純WebサイトのPRチュートリアル", + }, + { + text: "グローバル版を含む海外クライアントの対応について", + icon: "ri:earth-fill", + link: "/ja-jp/2.5-OVERSEAS_CLIENTS_ADAPTATION", + }, + ], + }, + { + text: "プロトコルドキュメント", + icon: "basil:document-solid", + collapsible: true, + children: [ + { + text: "インテグレーション", + icon: "bxs:book", + link: "/ja-jp/3.1-統合ドキュメント", + }, + { + text: "コールバック図解", + icon: "material-symbols:u-turn-left", + link: "/ja-jp/3.2-コールバックAPI", + }, + { + text: "自動作戦図解", + icon: "ph:sword-bold", + link: "/ja-jp/3.3-自動作戦API", + }, + { + text: "タスク図解", + icon: "material-symbols:task", + link: "/ja-jp/3.4-タスクAPI", + }, + { + text: "統合戦略図解", + icon: "ri:game-fill", + link: "/ja-jp/3.5-統合戦略API", + }, + { + text: "インフラスケジュール図解", + icon: "material-symbols:view-quilt-rounded", + link: "/ja-jp/3.6-インフラスケジュール設定", + }, + { + text: "セキュリティプレゼンス図解", + icon: "game-icons:prisoner", + link: "/ja-jp/3.7-SECURITY_PRESENCE_SCHEMA", + }, + ], + }, + ], +}); diff --git a/docs/.vuepress/sidebar/ko-kr.ts b/docs/.vuepress/sidebar/ko-kr.ts new file mode 100644 index 0000000000..a6e98313ae --- /dev/null +++ b/docs/.vuepress/sidebar/ko-kr.ts @@ -0,0 +1,124 @@ +import { sidebar } from "vuepress-theme-hope"; + +export const kokrSidebar = sidebar({ + "/ko-kr/": [ + { + text: "MAA", + icon: "ic:round-home", + link: "/ko-kr/", + }, + { + text: "사용자 설명서", + icon: "mdi:user", + collapsible: true, + children: [ + { + text: "기능", + icon: "mdi:information-outline", + link: "/ko-kr/1.1-사용자_설명서", + }, + { + text: "자주 묻는 질문", + icon: "ph:question-fill", + link: "/ko-kr/1.2-FAQ", + }, + { + text: "에뮬레이터 지원", + icon: "mingcute:laptop-fill", + collapsible: true, + children: [ + { + text: "Windows", + icon: "ri:windows-fill", + link: "/ko-kr/1.3-에뮬레이터_지원", + }, + { + text: "Mac", + icon: "basil:apple-solid", + link: "/ko-kr/1.4-Mac에뮬레이터_지원", + }, + { + text: "Linux", + icon: "teenyicons:linux-alt-solid", + link: "/ko-kr/1.5-LINUX용_에뮬레이터 지원", + }, + ], + }, + ], + }, + { + text: "개발 관련", + icon: "ph:code-bold", + collapsible: true, + children: [ + { + text: "리눅스 컴파일 튜토리얼", + icon: "teenyicons:linux-alt-solid", + link: "/ko-kr/2.1-LINUX_튜토리얼", + }, + { + text: "개발 환경 구축하기", + icon: "iconoir:developer", + link: "/ko-kr/2.2-개발_환경_구축하기", + }, + { + text: "Issue Bot 사용 방법", + icon: "bxs:bot", + link: "/ko-kr/2.3-Issue_Bot_사용방법", + }, + { + text: "GitHub Pull Request 사용 가이드", + icon: "mingcute:git-pull-request-fill", + link: "/ko-kr/2.4-웹을_통한_풀리퀘스트_튜토리얼", + }, + { + text: "해외 클라이언트 현지화", + icon: "ri:earth-fill", + link: "/ko-kr/2.5-해외_클라이언트_현지화", + }, + ], + }, + { + text: "프로토콜 문서", + icon: "basil:document-solid", + collapsible: true, + children: [ + { + text: "연동", + icon: "bxs:book", + link: "/ko-kr/3.1-연동", + }, + { + text: "콜백 스키마", + icon: "material-symbols:u-turn-left", + link: "/ko-kr/3.2-콜백_스키마", + }, + { + text: "전투 스키마", + icon: "ph:sword-bold", + link: "/ko-kr/3.3-전투_스키마", + }, + { + text: "작업 스키마", + icon: "material-symbols:task", + link: "/ko-kr/3.4-작업_스키마", + }, + { + text: "통합전략 스키마", + icon: "ri:game-fill", + link: "/ko-kr/3.5-통합전략_스키마", + }, + { + text: "기반시설 예약 스키마", + icon: "material-symbols:view-quilt-rounded", + link: "/ko-kr/3.6-기반시설_예약_스키마", + }, + { + text: "보안파견 스키마", + icon: "game-icons:prisoner", + link: "/ko-kr/3.7-보안파견_스키마", + }, + ], + }, + ], +}); diff --git a/docs/.vuepress/sidebar/zh-cn.ts b/docs/.vuepress/sidebar/zh-cn.ts new file mode 100644 index 0000000000..a126d9d4cd --- /dev/null +++ b/docs/.vuepress/sidebar/zh-cn.ts @@ -0,0 +1,124 @@ +import { sidebar } from "vuepress-theme-hope"; + +export const zhcnSidebar = sidebar({ + "/": [ + { + text: "MAA", + icon: "ic:round-home", + link: "/", + }, + { + text: "用户手册", + icon: "mdi:user", + collapsible: true, + children: [ + { + text: "功能介绍", + icon: "mdi:information-outline", + link: "/1.1-详细介绍", + }, + { + text: "常见问题", + icon: "ph:question-fill", + link: "/1.2-常见问题", + }, + { + text: "模拟器支持", + icon: "mingcute:laptop-fill", + collapsible: true, + children: [ + { + text: "Windows", + icon: "ri:windows-fill", + link: "/1.3-模拟器支持", + }, + { + text: "Mac", + icon: "basil:apple-solid", + link: "/1.4-Mac模拟器支持", + }, + { + text: "Linux", + icon: "teenyicons:linux-alt-solid", + link: "/1.5-Linux模拟器支持", + }, + ], + }, + ], + }, + { + text: "开发文档", + icon: "ph:code-bold", + collapsible: true, + children: [ + { + text: "Linux编译教程", + icon: "teenyicons:linux-alt-solid", + link: "/2.1-Linux编译教程", + }, + { + text: "开发相关", + icon: "iconoir:developer", + link: "/2.2-开发相关", + }, + { + text: "IssueBot使用方法", + icon: "bxs:bot", + link: "/2.3-IssueBot使用方法", + }, + { + text: "纯网页端PR教程", + icon: "mingcute:git-pull-request-fill", + link: "/2.4-纯网页端PR教程", + }, + { + text: "外服适配教程", + icon: "ri:earth-fill", + link: "/2.5-外服适配教程", + }, + ], + }, + { + text: "协议文档", + icon: "basil:document-solid", + collapsible: true, + children: [ + { + text: "集成文档", + icon: "bxs:book", + link: "/3.1-集成文档", + }, + { + text: "回调消息协议", + icon: "material-symbols:u-turn-left", + link: "/3.2-回调消息协议", + }, + { + text: "战斗流程协议", + icon: "ph:sword-bold", + link: "/3.3-战斗流程协议", + }, + { + text: "任务流程协议", + icon: "material-symbols:task", + link: "/3.4-任务流程协议", + }, + { + text: "肉鸽辅助协议", + icon: "ri:game-fill", + link: "/3.5-肉鸽辅助协议", + }, + { + text: "基建排班协议", + icon: "material-symbols:view-quilt-rounded", + link: "/3.6-基建排班协议", + }, + { + text: "保全派驻协议", + icon: "game-icons:prisoner", + link: "/3.7-保全派驻协议", + }, + ], + }, + ], +}); diff --git a/docs/.vuepress/sidebar/zh-tw.ts b/docs/.vuepress/sidebar/zh-tw.ts new file mode 100644 index 0000000000..b6809e247a --- /dev/null +++ b/docs/.vuepress/sidebar/zh-tw.ts @@ -0,0 +1,119 @@ +import { sidebar } from "vuepress-theme-hope"; + +export const zhtwSidebar = sidebar({ + "/zh-tw/": [ + { + text: "MAA", + icon: "ic:round-home", + link: "/zh-tw/", + }, + { + text: "用户手册", + icon: "mdi:user", + collapsible: true, + children: [ + { + text: "功能介绍", + icon: "mdi:information-outline", + link: "/zh-tw/1.1-詳細介紹", + }, + { + text: "常見問題", + icon: "ph:question-fill", + link: "/zh-tw/1.2-常見問題", + }, + { + text: "模擬器支援", + icon: "mingcute:laptop-fill", + collapsible: true, + children: [ + { + text: "Windows", + icon: "ri:windows-fill", + link: "/zh-tw/1.3-模擬器支援", + }, + { + text: "Mac", + icon: "basil:apple-solid", + link: "/zh-tw/1.4-Mac模擬器支援", + }, + ], + }, + ], + }, + { + text: "開發文檔", + icon: "ph:code-bold", + collapsible: true, + children: [ + { + text: "Linux編譯教程", + icon: "teenyicons:linux-alt-solid", + link: "/zh-tw/2.1-Linux編譯教程", + }, + { + text: "开发相关", + icon: "iconoir:developer", + link: "/zh-tw/2.2-開發相關", + }, + { + text: "IssueBot使用方法", + icon: "bxs:bot", + link: "/zh-tw/2.3-IssueBot使用方法", + }, + { + text: "純網頁端PR教程", + icon: "mingcute:git-pull-request-fill", + link: "/zh-tw/2.4-純網頁端PR教程", + }, + { + text: "外服適配教程", + icon: "ri:earth-fill", + link: "/zh-tw/2.5-外服適配教程", + }, + ], + }, + { + text: "協定文檔", + icon: "basil:document-solid", + collapsible: true, + children: [ + { + text: "集成文檔", + icon: "bxs:book", + link: "/zh-tw/3.1-集成文件", + }, + { + text: "回调消息协议", + icon: "material-symbols:u-turn-left", + link: "/zh-tw/3.2-回呼訊息協定", + }, + { + text: "戰鬥流程協定", + icon: "ph:sword-bold", + link: "/zh-tw/3.3-戰鬥流程協定", + }, + { + text: "任务流程协议", + icon: "material-symbols:task", + link: "/zh-tw/3.4-任務流程協定", + }, + { + text: "肉鸽輔助協定", + icon: "ri:game-fill", + link: "/zh-tw/3.5-肉鸽輔助協定", + }, + { + text: "基建排班协议", + icon: "material-symbols:view-quilt-rounded", + link: "/zh-tw/3.6-基建排班協議", + }, + { + text: "保全派駐協議", + icon: "game-icons:prisoner", + link: "/zh-tw/3.7-保全派駐協議", + }, + ], + }, + ], +}); diff --git a/docs/.vuepress/styles/config.scss b/docs/.vuepress/styles/config.scss new file mode 100644 index 0000000000..317c54529e --- /dev/null +++ b/docs/.vuepress/styles/config.scss @@ -0,0 +1 @@ +$theme-colors: #2196f3, #f26d6d, #3eaf7c, #fb9b5f; diff --git a/docs/.vuepress/styles/index.scss b/docs/.vuepress/styles/index.scss index 6837588299..d95d77274f 100644 --- a/docs/.vuepress/styles/index.scss +++ b/docs/.vuepress/styles/index.scss @@ -1,3 +1,16 @@ -:root { - --content-width: 1280px; +.home { + .vp-hero-info-wrapper { + min-height: 600px; + } +} + +.catalog-display-container { + overflow-x: visible; + overflow-y: auto; + + max-height: 75vh; + margin: 0.5rem; + border-radius: 0.5rem; + + overflow-wrap: break-word; } diff --git a/docs/.vuepress/theme.config.ts b/docs/.vuepress/theme.config.ts deleted file mode 100644 index c4dcf23306..0000000000 --- a/docs/.vuepress/theme.config.ts +++ /dev/null @@ -1,123 +0,0 @@ -import { defaultTheme } from '@vuepress/theme-default'; - -export default defaultTheme({ - repo: 'MaaAssistantArknights/MaaAssistantArknights', - sidebarDepth: 2, - docsBranch: 'dev', - docsDir: 'docs', - editLinkPattern: ':repo/edit/:branch/:path', - navbar: [ - // { text: "必读", link: "/guide.html" }, - { text: "MAA 官网", link: "/", target: "_blank" } - ], - locales: { - '/': { - selectLanguageName: '简体中文', - home: '/', - sidebar: { - '/': [ - '1.1-详细介绍.html', - '1.2-常见问题.html', - '1.3-模拟器支持.html', - '1.4-Mac模拟器支持.html', - '1.5-Linux模拟器支持.html', - '2.1-Linux编译教程.html', - '2.2-开发相关.html', - '2.3-IssueBot使用方法.html', - '2.4-纯网页端PR教程.html', - '2.5-外服适配教程.html', - '3.1-集成文档.html', - '3.2-回调消息协议.html', - '3.3-战斗流程协议.html', - '3.4-任务流程协议.html', - '3.5-肉鸽辅助协议.html', - '3.6-基建排班协议.html', - '3.7-保全派驻协议.html', - ], - }, - }, - '/zh-tw/': { - selectLanguageName: '繁體中文', - home: '/zh-tw/', - sidebar: { - '/zh-tw/': [ - '1.1-詳細介紹.html', - '1.2-常見問題.html', - '1.3-模擬器支援.html', - '1.4-Mac模擬器支援.html', - '2.1-Linux編譯教程.html', - '2.2-開發相關.html', - '2.3-IssueBot使用方法.html', - '2.4-純網頁端PR教程.html', - '2.5-外服適配教程.html', - '3.1-集成文件.html', - '3.2-回呼訊息協定.html', - '3.3-戰鬥流程協定.html', - '3.4-任務流程協定.html', - '3.5-肉鸽輔助協定.html', - '3.6-基建排班協議.html', - '3.7-保全派駐協議.html', - ], - }, - }, - '/en-us/': { - selectLanguageName: 'English', - home: '/en-us/', - sidebar: { - '/en-us/': [ - '1.1-USER_MANUAL.html', - '1.2-FAQ.html', - '1.3-EMULATOR_SUPPORTS.html', - '1.4-EMULATOR_SUPPORTS_FOR_MAC.md', - '1.5-EMULATOR_SUPPORTS_FOR_LINUX.html', - '2.1-LINUX_TUTORIAL.html', - '2.2-DEVELOPMENT.html', - '2.3-ISSUE_BOT_USAGE.html', - '2.4-PURE_WEB_PR_TUTORIAL.html', - '2.5-OVERSEAS_CLIENTS_ADAPTATION.html', - '3.1-INTEGRATION.html', - '3.2-CALLBACK_SCHEMA.html', - '3.3-COPILOT_SCHEMA.html', - '3.4-TASK_SCHEMA.html', - '3.5-INTEGRATED_STRATEGY_SCHEMA.html', - '3.6-INFRASTRUCTURE_SCHEDULING_SCHEMA.html', - '3.7-SECURITY_PRESENCE_SCHEMA.html', - ], - }, - }, - '/ja-jp/': { - selectLanguageName: '日本語', - home: '/ja-jp/', - sidebar: { - '/ja-jp/': [ - '1.1-詳細説明.html', - '1.2-よくある質問.html', - '1.3-エミュレータのサポート.html', - '2.1-Linuxチュートリアル.html', - '2.2-プルリクエスト.html', - '2.3-IssueBotの使用方法.html', - '2.4-純WebサイトのPRチュートリアル.html', - '2.5-OVERSEAS_CLIENTS_ADAPTATION.html', - '3.1-統合ドキュメント.html', - '3.2-コールバックAPI.html', - '3.3-自動作戦API.html', - '3.4-タスクAPI.html', - '3.5-統合戦略API.html', - '3.6-インフラスケジュール設定.html', - '3.7-SECURITY_PRESENCE_SCHEMA.html', - ], - }, - }, - '/ko-kr/': { - selectLanguageName: '한국어', - home: '/ko-kr/', - sidebar: { - '/ko-kr/': [ - '1.1-사용자_설명서.html', - '1.2-FAQ.html', - '1.3-에뮬레이터_지원.html', - ] - } - } - }, -}); diff --git a/docs/.vuepress/theme.ts b/docs/.vuepress/theme.ts new file mode 100644 index 0000000000..f35c92b51b --- /dev/null +++ b/docs/.vuepress/theme.ts @@ -0,0 +1,103 @@ +import { hopeTheme } from "vuepress-theme-hope"; +import { zhcnNavbar, zhtwNavbar, enusNavbar, jajpNavbar, kokrNavbar } from "./navbar/index"; +import { zhcnSidebar, zhtwSidebar, enusSidebar, jajpSidebar, kokrSidebar } from "./sidebar/index"; + +export default hopeTheme({ + hostname: "https://maa.plus", + iconAssets: "iconify", + repo: "MaaAssistantArknights/MaaAssistantArknights", + docsBranch: "dev", + docsDir: "/docs", + + locales: { + "/": { + navbar: zhcnNavbar, + sidebar: zhcnSidebar, + displayFooter: false, + metaLocales: { + editLink: "在Github上编辑此页面", + }, + }, + "/zh-tw/": { + navbar: zhtwNavbar, + sidebar: zhtwSidebar, + displayFooter: false, + metaLocales: { + editLink: "在Github上編輯此頁面", + }, + }, + "/en-us/": { + navbar: enusNavbar, + sidebar: enusSidebar, + displayFooter: false, + metaLocales: { + editLink: "Edit this page on Github", + }, + }, + "/ja-jp/": { + navbar: jajpNavbar, + sidebar: jajpSidebar, + displayFooter: false, + metaLocales: { + editLink: "このページをGithubで編集する", + }, + }, + "/ko-kr/": { + navbar: kokrNavbar, + sidebar: kokrSidebar, + displayFooter: false, + metaLocales: { + editLink: "Github에서 이 페이지를 편집", + }, + }, + }, + + sidebarIcon: true, + + plugins: { + activeHeaderLinks: false, + + comment: { + provider: "Giscus", + repo: "MaaAssistantArknights/maa-website", + repoId: "R_kgDOHY7Gyg", + category: "General", + categoryId: "DIC_kwDOHY7Gys4CYefe", + mapping: "title", + strict: false, + }, + + copyright: { + license: "AGPL-3.0", + }, + + mdEnhance: { + align: true, + card: true, + chart: true, + codetabs: true, + container: true, + echarts: true, + footnote: true, + gfm: true, + imgLazyload: true, + imgMark: true, + imgSize: true, + mathjax: true, + mark: true, + mermaid: true, + tabs: true, + tasklist: true, + vPre: true, + }, + + prismjs: { + light: "one-dark", + dark: "nord", + }, + + sitemap: true, + + }, + +}); diff --git a/docs/1.1-详细介绍.md b/docs/1.1-详细介绍.md index b6d397b0a9..4123c25ab6 100644 --- a/docs/1.1-详细介绍.md +++ b/docs/1.1-详细介绍.md @@ -1,3 +1,6 @@ +--- +icon: ic:baseline-article +--- # MAA使用说明 ## 功能介绍 diff --git a/docs/1.2-常见问题.md b/docs/1.2-常见问题.md index 85c4df4437..17b91909a8 100644 --- a/docs/1.2-常见问题.md +++ b/docs/1.2-常见问题.md @@ -1,3 +1,6 @@ +--- +icon: ph:question-fill +--- # 常见问题 ## 软件无法运行/闪退/报错 @@ -115,7 +118,7 @@ 3. **先关闭** MAA,**然后** 打开 `gui.json`,新增一个字段 `Bluestacks.Config.Path`,填入 `bluestacks.conf` 的完整路径。(注意斜杠要用转义 `\\`)
示例:(以 `C:\ProgramData\BlueStacks_nxt\bluestacks.conf` 为例) - ```jsonc + ```json { "Configurations": { "Default": { @@ -132,13 +135,13 @@ Nougat64核心: - ```jsonc + ```json "Bluestacks.Config.Keyword":"bst.instance.Nougat64.status.adb_port", ``` Pie64_2核心:(核心名称后的数字代表这是一个多开核心) - ```jsonc + ```json "Bluestacks.Config.Keyword": "bst.instance.Pie64_2.status.adb_port", ``` diff --git a/docs/1.3-模拟器支持.md b/docs/1.3-模拟器支持.md index cb454dfaff..3f86fb73e2 100644 --- a/docs/1.3-模拟器支持.md +++ b/docs/1.3-模拟器支持.md @@ -1,7 +1,15 @@ +--- +icon: ri:windows-fill +--- # Windows模拟器支持 -_注 1:遇到问题请先参阅 [1.2-常见问题](1.2-常见问题.md)_ -_注 2:以下模拟器排序为随机生成,排名不分先后_ +::: tip +遇到问题请先参阅 [1.2-常见问题](1.2-常见问题.md) +::: + +::: note +以下模拟器排序为随机生成,排名不分先后 +:::