Commit Graph

52 Commits

Author SHA1 Message Date
MistEO
02edf491c5 docs: Sync documents in all languages, Powered by AI (#14572)
Co-authored-by: MistEO <18511905+MistEO@users.noreply.github.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Manicsteiner <Manicsteiner@outlook.com>
2025-10-29 23:49:12 +08:00
MistEO
5e097de000 docs: 全语言开发文档章节整理 (#14562)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2025-10-28 16:00:58 +08:00
MistEO
63cce9811f docs: update prts.plus repo link 2025-10-12 20:02:28 +08:00
MistEO
0bed1d777a docs: 移除前端公招 2025-10-12 19:59:57 +08:00
Lucien Shaw
e72b6d5e24 docs: 添加目录自动跳转组件并使locale自动生成 (#14299)
* feat: 文档站添加重定向vue小组件

* revert: "docs: 将文档中指向部分文档目录的链接改为指向对应目录下的第一篇文档 (#14292)"

This reverts commit a24c772880.

* docs: zh-tw 目录自动跳转

* docs: zh-cn 目录自动跳转

* docs: ko-kr 目录自动跳转

* docs: ja-jp 目录自动跳转

* docs: en-us 目录自动跳转

* docs: 修复了多语言faq文章中的外链对应语言错误的问题

* refactor: 将matter模块改为default import

* feat: 将文档站的i18n和导航相关设置改为全自动生成

* fix: 去除了冗余的locale属性

文档站根据文件目录名称进行索引,linkName和dirName不可能不相同,故简化为单属性name

* refactor: 调整导航组件生成模块中的部分数据类型

* style: prettier fix
2025-10-04 23:44:54 +08:00
Goat Boring(山羊博宁88)
a24c772880 docs: 将文档中指向部分文档目录的链接改为指向对应目录下的第一篇文档 (#14292)
* Update newbie.md

* Update newbie.md

* Update newbie.md

* Update newbie.md

* Update newbie.md

* Update readme.md

* Update readme.md

* Update readme.md

* Update readme.md

* Update readme.md
2025-10-04 02:12:26 +08:00
Lucien Shaw
e461208bf9 chore: 完善容器配置及依赖安装 (#14208)
格式化工具部分:
1. pre-commit 引入 python 的格式化工具,包括 black(代码格式化)和 isort(对“包导入顺序”的规范)
2. 允许 prettier 对文档站的 markdown 文件格式化
3. 不允许 prettier 对 markdown 文件中的代码块的代码本身进行格式化
4. 升级了 pre-commit 的各个 hook 的版本
5. 优化了 pre-commit 的日志文本显示

容器总览部分:
1. 由原来的单一轻量环境转为区分空环境、轻量环境和全量环境
2. 空环境是裸 Linux 镜像(Ubuntu),为默认环境
3. 轻量环境适合开发文档站前端
4. 全量环境适合开发 MaaCore
5. 目前,全量环境完整包含了轻量环境,轻量环境完整包含了空环境
6. 在仓库 README.md 中更新了三个环境的描述,并将链接分别设置为对应环境的创建链接
   **注意:没有修改文档站中的对应文件**
7. 在各个语言的开发指南的最后,移除了 Codespace 部分的“安装额外依赖”相关描述,且将链接设置为全量环境的创建链接
   **注意:没有添加“开发文档站”的指南和对应 codespace 的使用方式**

容器的轻量环境和全量环境共有部分:
1. 安装 black 和 isort 包
2. 调整 VS Code 设置,取消先前(对 markdown 文件单独指定 markdownlint 扩展作为格式化工具)的错误设置,现在 markdown 文件仍然使用默认的 prettier 扩展作为格式化工具
3. 引入 markdown-all-in-one 扩展作为语法提示工具
4. 将 node_modules 和 3rdparty 排除在 VS Code 的文本的搜索路径之外

容器的全量环境部分:
1. 为 tools 下的所有 python 脚本安装依赖
2. 使用 tools/maadeps-download.py 下载 maadeps,且将必要二进制文件软链接到 /usr/local/bin/
3. 使用 apt 安装 cmake 和 clangd-20,将后者通过 update-alternatives 设置为系统 clangd 的默认版本
4. 使用 cmake tools 扩展,并按照 Linux 编译方法进行配置
5. 使用 clang-format 作为 c/cpp 的格式化工具,clang-format 程序主体来自 maadeps(已经软链接到 /usr/local/bin/)
6. 使用 clangd 作为 c/cpp 的语法提示工具
7. 将 MaaDeps、install 和 build 排除在 VS Code 的文本搜索路径之外

其它手动调整:
1. 更新文档站的 package.json,指定 pnpm 包管理器的版本
2. 手动保证 markdown 文件中的列表前后有空行(注意到 MarkdownLint 官方规则不一定能精准定位所有“列表前后空行”的问题,详见:https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md032---lists-should-be-surrounded-by-blank-lines )
3. 修改了部分 markdown 文件中的 json 代码块的语法问题
   **注意:相同的问题并未全部发现,仅修改了两处**
4. 在 tools 目录中,一处 python 脚本的包名误用(本地包名和某个 pip 包重名),这里修改了相应代码
5. 在 tools 目录中,一处 python 脚本使用了弃用的包 cchardet 的问题,这里更换了推荐使用的功能相近的包并修改了相应代码

自动化脚本提交的修改:
1. 自动格式化了大量 tools 中的 python 脚本
2. 自动格式化了大量 docs 中的 markdown 文件

Commits:

* chore: pre-commit引入black和isort规范py文件

* chore: Auto update by pre-commit hooks [skip changelog]

* chore: devcontainer添加isort扩展,排序python导入

* chore: pre-commit任务命名及更名

* style: isort fix

* chore: Auto update by pre-commit hooks [skip changelog]

* chore: 更新pre-commit的hook版本

* fix: 模块名与第三方库重名,大忌

* chore: 容器构建时额外安装isort

* docs: md -> markdown

* chore: 容器安装python包和maadeps

* fix: 修复过时python包

* chore: 指定pnpm版本

* chore: container支持选择轻量环境

* chore: 去掉rust

* chore: add plain env

* chore: 使用clangd语言服务器

* chore: 无需单独设置markdown的格式化工具

* chore: 更新安装的clangd版本

* docs: 简易文档适配

* docs: 在仓库README中重新编排codespaces相关指引

* chore: Auto update by pre-commit hooks [skip changelog]

* style: 调整缩进

* chore: 格式化工具不用特意排除被gitignore忽略的文件

* chore: sh文件在gitattributes中单列一类

* chore: 格式化docs下的markdown文件

* chore: 暂时不修改md文件中的代码块

* style: 人为明确markdown中的部分列表相关格式

* docs: 补上部分markdown的json代码块中缺失的逗号

* chore: Auto update by pre-commit hooks [skip changelog]

* chore: Auto update by pre-commit hooks [skip changelog]

* fix: 补上tools的服务器排序相关代码中缺失的逗号

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* chore: 使用maadeps的clangd

* build: 更新maadeps工具链版本

* style: prettier fix

* revert: 还原maadeps版本

* revert: 取消使用maadeps的clangd依赖,改用系统apt安装

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-09-30 19:39:48 +08:00
Rbqwow
1324165cfe docs: 修复文档站readme盾换行 2025-09-23 13:58:15 +00:00
MistEO
68248df197 docs: 标题MAA统一采用缩写 2025-09-23 01:41:48 +08:00
SherkeyXD
ada9b0849b docs(rft): 切换文档主题至 vuepress-theme-plume (#13821)
Co-authored-by: Lucien Shaw <myxlc55@outlook.com>
Co-authored-by: MistEO <mistereo@hotmail.com>
2025-09-18 18:26:14 +08:00
MistEO
f65e370620 docs: remove weblate 2025-09-08 22:12:29 +08:00
HX3N
3f271f9bb6 docs: KR update and overhaul entire documentation (#13550)
* docs: manual

* docs: protocol

* docs: develop

* chore: fix typo

* chore: fix more typo

* docs: readme

readme image

* chore: Auto update by pre-commit hooks [skip changelog]

* fix: corrected file name

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2025-08-06 18:33:38 +09:00
Rbqwow
74bb69b69d docs: 修复 readme logo
谁偷偷升依赖了?!
2025-07-16 23:02:29 +08:00
MistEO
dbc1f1f6da chore: ota.maa.plus -> api.maa.plus 2025-05-15 23:19:13 +08:00
Rbqwow
2fa5c743cc docs: 用户协议 (#11666)
* docs: 初版用户协议

* docs: 贴合AGPL-3.0修改协议(1/2)

* docs: 贴合AGPL-3.0修改协议(2/3)

* docs: 贴合AGPL-3.0修改协议(3/3)

* docs: 用户协议添加tldr

* docs: review (2/3)

Co-authored-by: AnnAngela <naganjue@vip.qq.com>

* docs: 学姐:把森空岛拆出来

* docs: tldr增加免责说明

* docs: 改个词

* docs: 赦免Mirror酱

* docs: 来点加粗

* docs: 强调一下官方账号

* docs: 成年

* docs: 企鹅物流不一定匿名

* docs: 玛

a3d81c6029

* docs: 添加超链接引用

* docs: review

玛

* docs: Update terms-of-service.md

* docs: review

玛玛

* docs: 玛说要有镜,于是丽便有了光

* docs: 写多了 但我的 git rebase -i 坏掉了 只能再推个commit

* docs: 修改文档

* docs: 客户端反作弊

* docs: no deepseek anymore

---------

Co-authored-by: AnnAngela <naganjue@vip.qq.com>
Co-authored-by: MistEO <mistereo@hotmail.com>
Co-authored-by: uye <99072975+ABA2396@users.noreply.github.com>
Co-authored-by: No-Deepseek <do-not-use-deepseek-to-suck-my-ass@rbqwow.icu>
2025-05-10 23:33:43 +08:00
MistEO
2f373ba893 docs: add space 2025-03-23 01:49:34 +08:00
MistEO
a13550370a docs: 协议抄错了x 2025-03-13 17:59:48 +08:00
MistEO
35089726d9 docs: 优化 DML 相关措辞 2025-03-13 17:56:15 +08:00
Constrat
eaac213d4f docs: change gamedata repo 2
[skip changelog]
2025-02-08 15:21:11 +01:00
Constrat
888582339f feat: discord link for website docs (#11687)
* feat: discord link for website docs

* i18n: zh-tw tweak

* i18n: jp tweak

* i18n: KR tweak

* i18n: zh-cn

---------

Co-authored-by: momomochi987 <as99us301@gmail.com>
Co-authored-by: ManicSteiner <manicsteiner@outlook.com>
Co-authored-by: HX3N <128385247+HX3N@users.noreply.github.com>
Co-authored-by: Rbqwow <55343783+Rbqwow@users.noreply.github.com>
2025-01-28 13:56:48 +01:00
Rbqwow
1bc82628f6 docs: README 移除 MaaX,更换前端仓库地址 (#11636) 2025-01-24 10:15:20 +08:00
Rbqwow
cc2968c2e9 docs: 更新文档 (#11430)
* docs: 更新文档

对不起我忘记拆分 commit 了

优化 winget 安装运行库命令
添加 一键修复运行库.ps1
将 image 文件夹重命名为 images
添加账号切换执行时机说明

土下座

Co-authored-by: SherkeyXD <57581480+SherkeyXD@users.noreply.github.com>

* docs: 跟上学姐的脚步

* fix: cli docs

---------

Co-authored-by: SherkeyXD <57581480+SherkeyXD@users.noreply.github.com>
2024-12-29 21:34:30 +08:00
uye
0128c309a9 docs: 更新 README (#11398)
* docs: 更新 README

* i18n: 更新外语 readme

* chore: Auto update by pre-commit hooks [skip changelog]

* chore: 还原误操作

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2024-12-26 15:19:40 +08:00
Rbqwow
902a70db23 docs: 运行库问题 (#10950)
* docs: 先改改大纲

* docs: 加回来个锚点

* docs: 糊完了

* docs: 加粗下划线

* i18n: 运行库问题

---------

Co-authored-by: uye <99072975+ABA2396@users.noreply.github.com>
2024-10-31 23:13:26 +08:00
MistEO
7888158f1b docs: 贡献者头像添加 105 上限 (#10351) 2024-08-24 11:57:00 +08:00
Rbqwow
dc153b34c7 docs: 修改下载地址
[skip changelog]
2024-08-20 06:23:24 +08:00
uye
788275c131 docs: 更新 README 2024-08-18 15:38:32 +08:00
Rbqwow
9108f01264 docs: 本地加载logo
[skip changelog]
2024-08-07 04:21:28 +08:00
Rbqwow
0773d31fd7 docs: 重写网页 PR 教程 (#10005)
* docs: 初步重写 PR 网页教程

* chore: Auto update by pre-commit hooks [skip changelog]

* docs: 再加一个按钮

* chore: Auto update by pre-commit hooks [skip changelog]

* fix: 先把图片路径修了

* docs: 不新建分支了

* chore: Auto update by pre-commit hooks [skip changelog]

* docs: 修复坏图片

* docs: 完成英语翻译 | English version completed (translated by gpt)

* chore: Auto update by pre-commit hooks [skip changelog]

* i18n: english tweaks

* i18n: english tweaks

---------

Co-authored-by: 晓丶梦丶仁 <1020623818@qq.com>
Co-authored-by: Constrat <56174894+Constrat@users.noreply.github.com>
2024-08-05 01:01:17 +08:00
Constrat
1d1f67c55d docs: GameData Yostar citation 2024-07-31 18:58:48 +02:00
Rbqwow
7986f03568 docs: 修复Readme中的Weblate链接 2024-07-31 04:12:24 +08:00
Loong
62ffdc73cb ci: use lychee to check dead links (#9675)
* ci: use lychee to check dead links

* ci: comment on PR when dead links are found

* docs: fix broken links
2024-07-17 15:26:17 +01:00
Loong
fd18e5704f chore: bump maa-cli to 0.4.8 and update documents (#9683)
* chore: bump maa-cli to 0.4.8 and update documents

* docs: 合并 cli 文档中的 README 和 intro

* docs: fix broken link to CLI guide

* docs: update order of CLI manual pages
2024-07-16 18:39:02 +01:00
Constrat
a340d515ad refactor: Yostar interface consistency
[no ci] [skip changelog]
2024-07-07 21:37:41 +02:00
uye
57fbe81be1 refactor: website docs **translation needed** (#9287)
Co-authored-by: wlwxj <d1ve_wh4le@outlook.com>
Co-authored-by: Rbqwow <55343783+Rbqwow@users.noreply.github.com>
Co-authored-by: Constrat <56174894+Constrat@users.noreply.github.com>
Co-authored-by: HX3N <scarlet7518@gmail.com>
Co-authored-by: Wallsman <63186641+wallsman@users.noreply.github.com>
Co-authored-by: Loong <wangl.cc@outlook.com>
Co-authored-by: 神代綺凛 <i@loli.best>
Co-authored-by: SherkeyXD <57581480+SherkeyXD@users.noreply.github.com>
2024-07-08 01:57:20 +08:00
HX3N
772b3b010e docs: fix incorrect link in KR docs
and modify warning message
2024-04-27 01:37:17 +09:00
Rbqwow
a469b1d4ca docs: 更新明日方舟工具箱地址 (#8835) 2024-04-21 20:28:28 +08:00
HX3N
4de621c182 docs: update and refactor KR docs (#8793)
* docs: update readme

* docs: Update Android Device and CLI

* docs:  Improvement of Document Structure

* docs: update schema

* docs: update sidebar and dev docs

* docs: reconstruction

* docs: navbar

* docs: fix incorrect link

docs: sidebar

docs: fix somethings

* docs: update image

* docs: Correcting missing or incorrect links

* docs: change image link

* docs: change sidebar display

Last Check

* docs: correcting incorrect
2024-04-09 23:25:20 +09:00
Rbqwow
f3eef61341 docs: 修复所有的一图流失效链接&同步两个readme 2024-02-14 21:43:00 +08:00
Rbqwow
95b3bea4be docs: 改掉ko-kr的<br>和bug 2024-02-14 21:24:41 +08:00
status102
553a5b641a docs: 修改readme中最大分辨率为2k 2024-01-02 15:34:37 +08:00
David
e4035c390a style: c -> C + total downloads 2023-11-23 19:10:59 +01:00
MistEO
5e919096ce docs: Enlarge contributors' avatars 2023-10-30 14:39:07 +08:00
MistEO
1417895436 docs: show avatar for all contributors 2023-10-30 14:29:47 +08:00
David
05c7776f1a docs: YostarEN recommended resolution (#6303)
1920*1080 recommendation for YostarEN clients
2023-09-13 09:34:27 +02:00
MistEO
fe1f59997c docs: 添加关联项目 MaaFramework 2023-07-27 14:32:30 +08:00
zewoosJ
be70cfb07d docs: add tutorial docs for kr (#5590)
Co-authored-by: Clock <snoo91919@gmail.com>
2023-07-22 21:26:51 +08:00
MistEO
2034abf7a3 feat: 更新海外客户端数据源,移除对 ArknightsGameData 的引用 2023-05-20 12:37:08 +08:00
MistEO
60feaffa39 docs: 更新文档数据源部分 2023-05-06 15:10:36 +08:00
MistEO
3722282852 chore: 更新资源更新器 2023-05-06 15:07:19 +08:00