Skip to content

Commit

Permalink
ci: 缓存链接检查结果
Browse files Browse the repository at this point in the history
Resolves #459
  • Loading branch information
YDX-2147483647 committed Dec 12, 2024
1 parent e710db7 commit e6498b9
Show file tree
Hide file tree
Showing 15 changed files with 41 additions and 47 deletions.
10 changes: 10 additions & 0 deletions .github/lychee.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
cache = true
max_cache_age = "30 days"

max_retries = 5
retry_wait_time = 30 # seconds

exclude = [
'^https://(grd|jwb|mirros|cs)\.bit\.edu\.cn',
'^https://tex\.stackexchange\.com',
]
19 changes: 16 additions & 3 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,21 @@ jobs:
- run: pnpm build
- run: pnpm lint:prettier

markdown-link-check:
check-links:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: gaurav-nelson/github-action-markdown-link-check@v1
- uses: actions/checkout@v4
- name: Restore the cache
uses: actions/cache@v4
with:
path: .lycheecache
key: lychee-${{ github.sha }}
restore-keys: lychee-
- name: Check links
uses: lycheeverse/lychee-action@v2
with:
args: >-
--verbose
--no-progress
--config .github/lychee.toml
.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ node_modules
wiki/.vitepress/dist
.DS_Store
wiki/.vitepress/cache
.lycheecache
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ BIThesis 是针对北京理工大学本科生毕业毕业论文、研究生学
**本项目为 [BIThesis 在线文档](https://bithesis.bitnp.net) 的代码仓库。如果你仅仅想使用 BIThesis,请访问 [BIThesis](https://github.com/BITNP/BIThesis) 仓库。**

> [!NOTE]
> 本项目获得了[北京理工大学研究生院](https://grd.bit.edu.cn/xwgz/xwgz2/wjxz_xwgz/b117824.htm)[北京理工大学教务部](http://jwb.bit.edu.cn/)[北京理工大学计算机学院](http://cs.bit.edu.cn/) 的认可、背书与大力支持。详见:[致谢 - 官方赞助](https://bithesis.bitnp.net/guide/acknowledgements.html#%E5%AE%98%E6%96%B9%E8%B5%9E%E5%8A%A9-official-sponsors)
> 本项目获得了[北京理工大学研究生院](https://grd.bit.edu.cn/xwgz/xwgz2/wjxz_xwgz/b117824.htm)[北京理工大学教务部](https://jwb.bit.edu.cn/)[北京理工大学计算机学院](https://cs.bit.edu.cn/) 的认可、背书与大力支持。详见:[致谢 - 官方赞助](https://bithesis.bitnp.net/guide/acknowledgements.html#%E5%AE%98%E6%96%B9%E8%B5%9E%E5%8A%A9-official-sponsors)
<h2>交流社区</h2>

Expand Down
30 changes: 0 additions & 30 deletions mlc_config.json

This file was deleted.

2 changes: 1 addition & 1 deletion wiki/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,4 +108,4 @@ TeXstudio 是老牌 LaTeX 编辑器,使用跨平台技术 Qt 编写而成。

默认情况下 TeXstudio 的编译工具链均已经配置完毕,基本开箱即用。对于如何用 TeXstudio 编译本模板,请继续阅读。

准备就绪后,我们就可以开始使用 BIThesis 提供的模板进行 LaTeX 文档的撰写啦!请继续阅读:[📃 下载与使用模板](/guide/downloading-using-templates.md)
准备就绪后,我们就可以开始使用 BIThesis 提供的模板进行 LaTeX 文档的撰写啦!请继续阅读:[📃 下载与使用模板](./downloading-using-templates.md)
6 changes: 3 additions & 3 deletions wiki/guide/preface.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ BIThesis 是针对北京理工大学本科以及研究生同学毕业论文制
**A:可以的。**

- 本项目已经经由北京理工大学教务部确认,可以用于北京理工大学本科生毕业论文、毕业设计的撰写之中。更多细节,请进入文档详细了解。
- 本项目同时也获得了 [北京理工大学教务部](https://jwb.bit.edu.cn/)[北京理工大学计算机学院](https://cs.bit.edu.cn/) 的认可、背书与大力支持。详见:[致谢 - 官方赞助](/guide/acknowledgements.md)
- 本项目同时也获得了 [北京理工大学教务部](https://jwb.bit.edu.cn/)[北京理工大学计算机学院](https://cs.bit.edu.cn/) 的认可、背书与大力支持。详见:[致谢 - 官方赞助](./acknowledgements.md)

**我们正在对项目持续更新!目前,你完全可以使用现有版本开始编写毕业设计总论文;不过与此同时,我们也在持续推进代码的升级和更新(主要是不影响使用的底层逻辑)。更多开发计划请访问我们的 [Roadmap](https://github.com/BITNP/BIThesis/projects)。想帮助这个项目持续前进?参见我们的[贡献者指南](https://github.com/BITNP/BIThesis/blob/main/contributing-zh.md)**

Expand Down Expand Up @@ -49,13 +49,13 @@ BIThesis 是针对北京理工大学本科以及研究生同学毕业论文制
- 面向没有太多计算机基础的同学
- 附图的 PDF

2. 本 Wiki 「[**食用方法**](/guide/intro.md)
2. 本 Wiki 「[**食用方法**](./intro.md)

- 面向有一定计算机基础的同学
- 一系列网页
- 详细介绍各种情况的使用方法和注意事项

此外也可直接前往「[系列视频指导](/video/intro.md)」,根据视频的介绍进行学习使用。(录制于 2020 年,与目前的模板使用方式有些许出入;仅供参考)
此外也可直接前往「[系列视频指导](../video/intro.md)」,根据视频的介绍进行学习使用。(录制于 2020 年,与目前的模板使用方式有些许出入;仅供参考)

无论如何,BIThesis 的教程参考都几乎涵盖了全部使用 BIThesis 所需的编译环境和基础知识。请大家放心食用。

Expand Down
2 changes: 1 addition & 1 deletion wiki/guide/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,4 +161,4 @@ Package minted Error: You must invoke LaTeX with the -shell-escape flag.

原因是:你使用了 V2.x 的模板,但是本机的 LaTeX 环境没有更新到最新,并未包含 `bithesis` 宏集。

解决方案:安装最新的 LaTeX 环境,或通过包管理器手动安装 `bithesis` 宏集。(更多内容请参考 [文档 - 🍌 如何开始](/guide/getting-started.md)。)
解决方案:安装最新的 LaTeX 环境,或通过包管理器手动安装 `bithesis` 宏集。(更多内容请参考 [文档 - 🍌 如何开始](./getting-started.md)。)
2 changes: 1 addition & 1 deletion wiki/video/episode-1.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# 第一节 综述

<div id="embed-video">
<iframe src="//player.bilibili.com/player.html?aid=925350795&bvid=BV1GT4y1V78d&cid=181709301&page=2&high_quality=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" ></iframe>
<iframe src="https://player.bilibili.com/player.html?aid=925350795&bvid=BV1GT4y1V78d&cid=181709301&page=2&high_quality=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" ></iframe>
</div>

## 视频相关说明
Expand Down
2 changes: 1 addition & 1 deletion wiki/video/episode-2.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# 第二节 LaTeX 的下载和安装

<div id="embed-video">
<iframe src="//player.bilibili.com/player.html?aid=925350795&bvid=BV1GT4y1V78d&cid=181709301&page=3&high_quality=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" ></iframe>
<iframe src="https://player.bilibili.com/player.html?aid=925350795&bvid=BV1GT4y1V78d&cid=181709301&page=3&high_quality=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" ></iframe>
</div>

## 视频相关说明
Expand Down
2 changes: 1 addition & 1 deletion wiki/video/episode-3.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# 第三节 LaTeX 基本介绍

<div id="embed-video">
<iframe src="//player.bilibili.com/player.html?aid=925350795&bvid=BV1GT4y1V78d&cid=181709301&page=4&high_quality=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" ></iframe>
<iframe src="https://player.bilibili.com/player.html?aid=925350795&bvid=BV1GT4y1V78d&cid=181709301&page=4&high_quality=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" ></iframe>
</div>

## 视频相关说明
Expand Down
2 changes: 1 addition & 1 deletion wiki/video/episode-4.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# 第四节 模板的下载与使用

<div id="embed-video">
<iframe src="//player.bilibili.com/player.html?aid=925350795&bvid=BV1GT4y1V78d&cid=181709301&page=5&high_quality=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" ></iframe>
<iframe src="https://player.bilibili.com/player.html?aid=925350795&bvid=BV1GT4y1V78d&cid=181709301&page=5&high_quality=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" ></iframe>
</div>

## 视频相关说明
Expand Down
2 changes: 1 addition & 1 deletion wiki/video/episode-5.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# 第五节 格式转化

<div id="embed-video">
<iframe src="//player.bilibili.com/player.html?aid=925350795&bvid=BV1GT4y1V78d&cid=181709301&page=6&high_quality=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" ></iframe>
<iframe src="https://player.bilibili.com/player.html?aid=925350795&bvid=BV1GT4y1V78d&cid=181709301&page=6&high_quality=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" ></iframe>
</div>

## 视频相关说明
Expand Down
2 changes: 1 addition & 1 deletion wiki/video/episode-6.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# 第六节 项目介绍与疑难解惑

<div id="embed-video">
<iframe src="//player.bilibili.com/player.html?aid=925350795&bvid=BV1GT4y1V78d&cid=181709301&page=7&high_quality=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" ></iframe>
<iframe src="https://player.bilibili.com/player.html?aid=925350795&bvid=BV1GT4y1V78d&cid=181709301&page=7&high_quality=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" ></iframe>
</div>

## 视频相关说明
Expand Down
4 changes: 2 additions & 2 deletions wiki/video/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ BIThesis 主创团队也联合北京理工大学「京工拾光工作室」为
:::

:::danger `v3.x.x` 观看提示
此系列视频制作于 2020 年年初,主要针对 `v1.x` 版本(2019 - 2020)的 BIThesis 进行解说。但在 `v3.x.x` 版本(2022 - 今)中,BIThesis 的使用方式与原有版本有些出入(详见下文)。我们十分建议你在观看视频的同时,也阅读相应的 [文档指南](/guide/intro.md) 作为补充。
此系列视频制作于 2020 年年初,主要针对 `v1.x` 版本(2019 - 2020)的 BIThesis 进行解说。但在 `v3.x.x` 版本(2022 - 今)中,BIThesis 的使用方式与原有版本有些出入(详见下文)。我们十分建议你在观看视频的同时,也阅读相应的 [文档指南](../guide/intro.md) 作为补充。
:::

## BIThesis `v3.x.x``v2.x.x``v1.x.x` 的区别是什么?
Expand Down Expand Up @@ -40,5 +40,5 @@ BIThesis 主创团队也联合北京理工大学「京工拾光工作室」为
## BIThesis 预告片 <Badge text="大误"/>

<div id="embed-video">
<iframe src="//player.bilibili.com/player.html?aid=925350795&bvid=BV1GT4y1V78d&cid=181709301&page=1&high_quality=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" ></iframe>
<iframe src="https://player.bilibili.com/player.html?aid=925350795&bvid=BV1GT4y1V78d&cid=181709301&page=1&high_quality=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" ></iframe>
</div>

0 comments on commit e6498b9

Please sign in to comment.