注意：如果使用本项目搭建开源镜像站，必须：
- 移除所有与清华大学和 TUNA 相关的内容，包括且不限于站名、logo 和各种文档中出现的所有相关文本和图形；
- 在网站首页恰当标注项目来源（
tuna/mirror-web）； - 遵循 GPLv2 协议开放修改后的源代码；
除具体页面内容外，可修改的配置还包括：
_config.yml：Jekyll 配置文件，包括站点名称、描述、链接等；请不要轻易改动构建配置。_data/options.yml：Jekyll 数据文件，主要包括各个镜像的简要描述和部分特殊镜像的配置。请仿照已有的配置进行修改。geninfo/genisolist.ini：生成直接下载链接的配置文件。具体内容修改请提交到 mirrorz-org/genisolist。
本站使用 Jekyll 编写，并使用了 Vue、TypeScript、Vite 等前端框架开发。
由于本站部分文档使用 submodule 方式嵌入仓库，clone 后构建前请运行 git submodule update --init。
为正常运行，一些动态数据文件需要从镜像站下载：
wget https://mirrors.tuna.tsinghua.edu.cn/static/tunasync.json -O static/tunasync.json
mkdir -p static/status
wget https://mirrors.tuna.tsinghua.edu.cn/static/status/isoinfo.json -O static/status/isoinfo.json编译前，先安装 Ruby (>= 3.0) 和 Node.js (>= 18)，然后执行：
bundle install --deployment
npm install
bundle exec jekyll build # 编译到 `_site/` 目录，或者
bundle exec jekyll serve --livereload # 实时预览在编译时可选的环境变量：
JEKYLL_ENV=production：编译生产版本（启用代码压缩），可能需要较长时间。VISUALIZER=true：生成 Rollup 编译体积分析文件到_stats.html。
仓库中的 Dockerfile.build 也可用于编译，推荐在生产环境部署时使用。
可用以下命令构建（如依赖无变化，镜像无需重复构建）：
docker build -t tunathu/mirror-web -f Dockerfile.build .
docker pull tunathu/mirror-web # 或者直接拉取构建时，仅需将本地目录挂载到容器中：
docker run --rm -v /path/to/mirror-web:/data tunathu/mirror-web即可在 /path/to/mirror-web/_site 中得到编译结果。
本项目使用 Jekyll 作为唯一入口完成全部的构建流程。其具体流程是：
- Jekyll 读取
_config.yml和全部需要渲染的页面，并读取_data中的数据文件； - Jekyll 调用 vite 的 Jekyll 插件，将所有的前端代码编译到
_site/assets目录： - 插件将需要传递给 vite 的数据编码为 JSON，并写入临时文件；
- 插件执行 vite 命令，根据
_vite.config.mjs中的配置编译前端代码；_vite.config.mjs读取临时文件，向 vite 流程中注册虚拟导入文件；- vite 中注册的
vite-plugin-ruby插件导入其配置文件； - vite 加载
_src/entrypoints中的代码，并生成依赖树； - vite 中注册的
vite-plugin-legacy插件增加一份输出版本，并增加 legacy 标志； - vite 完成各代码的编译：
- 对于 Vue 组件，调用 Vue 的 SFC 编译器完成编译；
- 对于其中模板（
<template>）使用 Liquid 语法的组件，调用 Liquid 编译器完成编译；
- 对于其中模板（
- 对于 TypeScript 文件，调用 TypeScript 编译器完成编译；
- 对于 Vue 组件，调用 Vue 的 SFC 编译器完成编译；
- vite 完成代码各输出版本的后处理：
- 对于 legacy 标志的输出版本，
vite-plugin-legacy使用 babel 转译，并记录所需的 polyfill； - 对于正常的输出版本，正常编译；
- 对于 legacy 标志的输出版本，
- vite 产生编译结果：
vite-plugin-legacy新建一个 vite 流水线，并将所需的 polyfill 作为入口，并将编译结果插入到 legacy 版本的输出中；- 对上述
vite-plugin-legacy产生的 polyfill 代码，再次使用 babel 转译； - 新建一个 vite 流水线，并将
_src/entrypoints-njs中的代码作为入口，编译结果插入到正常版本的输出中；- 其中，使用 babel 转译生成的 njs 代码，确保其可以在 NGINX 的 njs 模块中运行；
vite-plugin-ruby对所有输出的文件，生成一个 manifest 文件，用于 Jekyll 插件读取；
- vite 输出编译结果到
.jekyll-cache/vite-dist下；
- 插件将 vite 的输出文件注册到 Jekyll 的静态文件列表中；
- 插件读入 vite 产生的 manifest 文件，备用；
- Jekyll 完成所有的页面渲染：
- 对于静态文件，直接拷贝到
_site目录； - 对于需要渲染的 html 文件，使用 Liquid 渲染引擎渲染；
- 其中，需要调用 Jekyll 的 vite 插件注册的 Liquid 指令，生成前端代码的引用，后者根据已经加载的 manifest 文件，生成正确的引用指令。
- 对于静态文件，直接拷贝到
本项目使用 NGINX 的 fancy-index 模块美化镜像站的文件列表展示。具体配置方法如下：
-
确保 nginx 安装了
ngx_http_fancyindex_module和ngx_http_js_module，并确保后者的版本不低于 0.7.9； -
在
nginx.conf对应的server配置块中添加如下配置：js_path /path/to/build_output/static/njs; # 以下设定不能修改，以便与 mirror-web 的前端代码配合 fancyindex_time_format "%d %b %Y %H:%M:%S +0000"; fancyindex_show_path on; fancyindex_header /fancy-index/before; fancyindex_footer /fancy-index/after; # 以下设定为推荐设置，fancyindex 的其它设定亦可按需修改 fancyindex_exact_size off; fancyindex_name_length 256; location /fancy-index { internal; root /path/to/build_output; subrequest_output_buffer_size 100k; js_import fancyIndexRender from fancy_index.njs; location = /fancy-index/before { js_content fancyIndexRender.fancyIndexBeforeRender; } location = /fancy-index/after { js_content fancyIndexRender.fancyIndexAfterRender; } }
-
然后在需要开启目录浏览的
location配置块中添加：fancyindex on;
本项目使用 mirrorz-org/genisolist 生成供前端渲染的 JSON 文件，请查看该项目的文档进行部署和修改。
如果增加了新的配置，不要忘记在 geninfo/genisolist.ini 中增加新的 !include 指令。
目前文档分为两部分维护，一部分是通用文档（help/_posts/mirrorz-help-ng-transpiled 目录），从 mirrorz-org/mirrorz-docs 生成，在 TUNA 本地化维护在 tuna/mirrorz-help-ng ，最终以 submodule 方式引入本仓库。如果您的改动是镜像站通用的，可以向前者贡献内容；如果是 TUNA 特有的，可以向后者 PR 。
另一部分维护在本仓库内（help/_posts/ 目录），需要向本仓库进行 PR 。mirror-web 会逐渐迁移到使用通用文档。
- Fork 本项目并 clone
- 创建分支
git checkout -b foo-doc - 在
help/_post中建立文档文件，文件名格式为年-月-日-名称.md - 用 Markdown 语法编写文档
- 提交并推送代码
- 发送 Pull Request
- 对于相对不知名的镜像项目，首先用一两句话介绍该项目
- 写明使用方法, 使用 Github Flavored Markdown 格式
- 中英文字符间应留一个空格
该功能实现在 mirrorz-org/mirrorz-help 中，需要让相应文档迁移到使用通用文档以该功能。
即将推出（TODO）：快速配置、拷贝命令、线路选择……
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "github-actions[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent
