doc: add config info in README

Signed-off-by: Harry Chen <i@harrychen.xyz>
This commit is contained in:
Harry Chen 2024-04-21 01:10:06 +08:00 committed by Miao Wang
parent 9df1857199
commit f23f7b6150
2 changed files with 33 additions and 29 deletions

View File

@ -1,19 +1,25 @@
# TUNA mirrors 主页 # TUNA 镜像站主页
注意:如果使用本项目搭建开源镜像站,**必须** 注意:如果使用本项目搭建开源镜像站,**必须**
* 移除所有与清华大学和 TUNA 相关的内容包括且不限于站名、logo 和各种文档中出现的所有文本和图形; * 移除所有与清华大学和 TUNA 相关的内容包括且不限于站名、logo 和各种文档中出现的所有相关文本和图形;
* 在网站首页恰当标注项目来源(`tuna/mirror-web` * 在网站首页恰当标注项目来源(`tuna/mirror-web`
* 遵循 GPLv2 协议开放修改后的源代码; * 遵循 GPLv2 协议开放修改后的源代码;
## 注意事项 ## 配置修改
由于本站部分文档使用 submodule 方式嵌入仓库clone 后构建前请运行 `git submodule update --init` 除具体页面内容外,可修改的配置还包括:
* `_config.yml`Jekyll 配置文件,包括站点名称、描述、链接等;请不要轻易改动构建配置。
* `_data/options.yml`Jekyll 数据文件,主要包括各个镜像的简要描述和部分特殊镜像的配置。请仿照已有的配置进行修改。
* `geninfo/genisolist.ini`:生成直接下载链接的配置文件。请参见已有配置和注释进行修改。
## 编译方式 ## 编译方式
本站使用 Jekyll 编写,并使用了 Vue、TypeScript、Vite 等前端框架开发。 本站使用 Jekyll 编写,并使用了 Vue、TypeScript、Vite 等前端框架开发。
由于本站部分文档使用 submodule 方式嵌入仓库clone 后构建前请运行 `git submodule update --init`
### 本地开发 ### 本地开发
为正常运行,一些动态数据文件需要从镜像站下载: 为正常运行,一些动态数据文件需要从镜像站下载:

View File

@ -1,11 +1,5 @@
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely need to edit after that.
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'jekyll serve'. If you change this file, please restart the server process.
# Site settings # Site settings
title: 清华大学开源软件镜像站 title: 清华大学开源软件镜像站
# title: 北京外国语大学开源软件镜像站 # title: 北京外国语大学开源软件镜像站
school: 清华大学 school: 清华大学
@ -37,7 +31,28 @@ mirrorz_desc: 校园网联合镜像站
mirrorz_link: "https://mirrors.cernet.edu.cn/list" mirrorz_link: "https://mirrors.cernet.edu.cn/list"
mirrorz_help_link: "https://help.mirrors.cernet.edu.cn/" mirrorz_help_link: "https://help.mirrors.cernet.edu.cn/"
# Build settings sponsors:
megvii:
name: "旷视科技有限公司"
link: "https://megvii.com/"
short: "旷视"
eng: "Megvii Technology Ltd."
logo: "megvii-s"
huawei:
name: "华为技术有限公司"
link: "https://huawei.com/"
short: "华为"
eng: "Huawei Technologies Co., Ltd."
logo: "huawei"
poweredbys:
kunpeng: "海思<sup>®</sup> Kunpeng<sup>®</sup> 920 处理器"
# ==================================
# Build settings below, DO NOT TOUCH
# ==================================
highlighter: rouge highlighter: rouge
markdown: kramdown markdown: kramdown
kramdown: kramdown:
@ -69,21 +84,4 @@ addition_exclude:
- Dockerfile* - Dockerfile*
- LICENSE - LICENSE
sponsors:
megvii:
name: "旷视科技有限公司"
link: "https://megvii.com/"
short: "旷视"
eng: "Megvii Technology Ltd."
logo: "megvii-s"
huawei:
name: "华为技术有限公司"
link: "https://huawei.com/"
short: "华为"
eng: "Huawei Technologies Co., Ltd."
logo: "huawei"
poweredbys:
kunpeng: "海思<sup>®</sup> Kunpeng<sup>®</sup> 920 处理器"
# vim: ts=2 sts=2 sw=2 expandtab # vim: ts=2 sts=2 sw=2 expandtab