Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 3.08 KB

README.zh.md

File metadata and controls

73 lines (52 loc) · 3.08 KB

吉林大学开源镜像站

English README

本仓库是吉林大学开源镜像站的网站前端界面。

功能

本站

  • 完全由静态的 HTML+CSS+JS 制成
  • 使用 NGINX 的 SSI (server-side inclusion) 模块作为简单模板引擎
  • 使用 Vue.js 2.x 在客户端渲染动态 API 结果
  • 需要与 shine 提供的 API 一起使用
  • 使用 normalize.css 作为样式表基础
  • 使用 Marked 渲染 markdown 格式的新闻与文档
  • 可以使用 NGINX 的 fancyindex 模块提供友好的目录浏览和 noscript 支持
    • 镜像站实际使用的 fancyindex 经过魔改

安装

可选择将网站文件和镜像们放在一起: ln -srf public/* /mirrors_root/

可选生成一个大文件供测速: dd if=/dev/urandom of=public/_static/speedtest.bin bs=1M count=1024

_{docs|news} 中按照如下命名规则创建新闻与文档, 生成 JSON 索引: ./index.py

如果服务器不支持 SSI ,可以本地离线渲染: ./ssi.py

NGINX 配置示例参见 nginx-vhost.conf

文件结构

  • public/
    • _docs/ - 镜像站文档
      • [mirror].{en|zh}.md - 带有语言后缀的 markdown 格式文档
      • index.json - 生成的索引
      • _index.html - 文档页面模板
    • _news/ - 新闻和公告
      • YYYY-MM-DD-[title].md - 带有日期前缀的 markdown 格式新闻
      • index.json - 生成的索引
      • _index.html - 新闻页面模板
    • _static/
      • lib/ - 引用的外部前端库
      • fancy/_{header|footer}.html - fancyindex 页面模板
      • common.{css|js} - 公共页面样式和脚本
      • {main|docs|news|fancy}.{css|js} - 特定页面样式和脚本
      • logo.svg - 网站图标
      • _{header|footer|ban}.html - HTML 页面模板
    • _index.html - 主页模板
  • index.py - 用于生成 _{doc|new}s/index.json
  • ssi.py - 用于渲染 _*.html SSI 模板
  • nginx-vhost.conf - NGINX 配置文件示例
  • LICENSE.txt - GNU AGPLv3 许可证文本
  • README(.zh).md - 本文档

许可协议

著作传所有 2022 吉林大学 Linux 用户协会。以 GNU Affero 通用公共许可协议第三版授权。

下列文件在 MIT 许可协议下授权:

  • src/static/lib/marked.js - 著作权所有 2011-2022 Christopher Jeffrey
  • src/static/lib/normalize.min.css - 著作权所有 Nicolas Gallagher 和 Jonathan Neal
  • src/static/lib/vue(.min).js - 著作权所有 2014-2021 Evan You

吉林大学的校徽属于吉林大学,需经学校单独许可使用。

致谢

设计本站期间,受到 TUNAUSTCLUGHITLUG 的镜像站很多启发。

特别感谢 ZenithalKeyu TaoBillchenchina