HUST Mirror 网页 & 文档

该网站使用 Docusaurus 构建。

开发

安装依赖

$ yarn

本地开发

$ yarn start

该命令会启动一个本地开发服务器，并打开一个浏览器窗口。大多数更改都会在不必重新启动服务器的情况下实时重载。

构建

$ yarn build

该命令会将静态内容生成到 build 目录中，可以使用任何静态内容托管服务进行服务。

自动生成 CLI

$ python scripts/parser.py

该命令会自动读取文档中可以生成 hustmirrors-cli 替换脚本的部分，并将其生成为相应镜像的脚本，保存在 generated_scripts 目录下。

有关编写自动生成镜像替换脚本的文档，请参考 USAGE.md

贡献

欢迎任何形式的贡献，包括但不限于提交问题报告、功能请求、文档改进、翻译等。

站点功能

如果您发现了站点的任何问题，或者有任何功能请求，请在 GitHub Issues 中提交一个问题报告， 或者直接提交一个 Pull Request。

文档改进

如果您发现了文档中的任何问题，或者有任何改进意见，请在 GitHub Issues 中提交一个问题报告， 或者直接提交一个 Pull Request。

文档格式

文档采用 Markdown 格式编写，如果需要支持用户交互的代码块，请参考 Ubuntu 文档的写法。

许可证

MIT