Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Deploy MkDocs to GitHub Pages # �������̵�����

on:
push:
branches:
- main # ָ�������� push �� main ��֧ʱ������������
# �����������֧���Ʋ��� main�����޸Ĵ˴������� master

jobs:
deploy: # ��ҵ�� ID
runs-on: ubuntu-latest # ָ����ҵ���������µ� Ubuntu ���⻷����

permissions:
contents: read # ������ȡ�ֿ�����
pages: write # ����� GitHub Pages �IJ���
id-token: write # ������ȡ OIDC token�����ڲ��� Pages

environment:
name: github-pages # ָ������ GitHub Pages ����
url: ${{ steps.deployment.outputs.page_url }} # �Ӳ������ȡ Pages URL

steps:
- name: Checkout code # �������ƣ���ȡ����
uses: actions/checkout@v4 # ʹ�� actions/checkout Action����ȡ�ֿ���뵽���⻷��

- name: Setup Python environment # �������ƣ����� Python ����
uses: actions/setup-python@v5 # ʹ�� actions/setup-python Action
with:
python-version: '3.x' # ָ��ʹ�õ� Python �汾������ 3.x ��ʾ���µ� Python 3 �汾
cache: pip # ���� pip ���������ٹ���

- name: Install dependencies # �������ƣ���װ����
run: | # ���������
python -m pip install --upgrade pip # ���� pip
pip install mkdocs mkdocs-material # ��װ MkDocs �� Material ���� (���ʹ�õĻ�)
# �����ʹ��������������������ڴ˴����Ӱ�װ����

- name: Build MkDocs site # �������ƣ�������վ
run: mkdocs build # ���� mkdocs build �������ɾ�̬�ļ���Ĭ������� site Ŀ¼

- name: Setup Pages # �������ƣ����� GitHub Pages
uses: actions/configure-pages@v3 # ʹ�� actions/configure-pages Action ���� Pages

- name: Upload artifact # �������ƣ��ϴ������õľ�̬�ļ�
uses: actions/upload-pages-artifact@v3 # ʹ�� actions/upload-pages-artifact Action
with:
path: './site' # ָ��Ҫ�ϴ���Ŀ¼��mkdocs build Ĭ�������� site Ŀ¼

- name: Deploy to GitHub Pages # �������ƣ����� GitHub Pages
id: deployment # ���������һ�� ID������������������
uses: actions/deploy-pages@v4 # ʹ�� actions/deploy-pages Action ���в���
# ��� Action ���Զ�����һ���ϴ��� artifact �л�ȡ�ļ�������
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1 @@
/site/
/site/
76 changes: 38 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@
# USTC 操作系统原理与设计 实验文档

所有实验文档位于 [./docs](./docs/) 目录中,每个实验单独存放独立的子目录,文档中使用的图片存放在相应子目录的 assets 目录里。目录与实验对应如下:

* [vmlab](./docs/vmlab/):虚拟机和 Linux 基本环境准备。
* [syscalllab](./docs/syscalllab/):为 Linux 内核添加系统调用。
* [shelllab](./docs/shelllab/):实现简单的 Shell。
* [malloclab](./docs/malloclab/):实现简单的内存分配器。
* [ohlab](./docs/ohlab/):OpenHarmony实现简单的端侧推理。

另外,[todo.md](./docs/todo.md) 中记录了一些待完成事项。

书写规范:

* 注意图片引用使用相对路径而不是绝对路径。

## 生成和测试

本项目使用 MkDocs 构建。使用下面命令可生成静态网站:

```bash
mkdocs build
```

使用下面命令在本地运行网站,进行测试:

```bash
mkdocs serve -a localhost:8000 # 可将8000改为其它端口
```



## 致谢

本文档参考了以下项目:

* [计算机系统结构系列实验文档](https://soc.ustc.edu.cn/)
* [USTC VLab 使用文档](https://vlab.ustc.edu.cn/docs/)([仓库](https://github.com/USTC-vlab/docs))
# USTC 操作系统原理与设计 实验文档
所有实验文档位于 [./docs](./docs/) 目录中,每个实验单独存放独立的子目录,文档中使用的图片存放在相应子目录的 assets 目录里。目录与实验对应如下:
* [vmlab](./docs/vmlab/):虚拟机和 Linux 基本环境准备。
* [syscalllab](./docs/syscalllab/):为 Linux 内核添加系统调用。
* [shelllab](./docs/shelllab/):实现简单的 Shell。
* [malloclab](./docs/malloclab/):实现简单的内存分配器。
* [ohlab](./docs/ohlab/):OpenHarmony实现简单的端侧推理。
另外,[todo.md](./docs/todo.md) 中记录了一些待完成事项。
书写规范:
* 注意图片引用使用相对路径而不是绝对路径。
## 生成和测试
本项目使用 MkDocs 构建。使用下面命令可生成静态网站:
```bash
mkdocs build
```
使用下面命令在本地运行网站,进行测试:
```bash
mkdocs serve -a localhost:8000 # 可将8000改为其它端口
```
## 致谢
本文档参考了以下项目:
* [计算机系统结构系列实验文档](https://soc.ustc.edu.cn/)
* [USTC VLab 使用文档](https://vlab.ustc.edu.cn/docs/)([仓库](https://github.com/USTC-vlab/docs))
14 changes: 7 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# USTC 操作系统原理与设计 实验文档

本站展示中国科大操作系统原理与设计课的实验文档。目前只是把已有的文档直接放了上来,没有调整格式错误等。

临时搭出来的网站,目前还很不完善,请大家包涵。

请以课程主页上的信息为准:[课程主页](http://staff.ustc.edu.cn/~ykli/os2025/)
# USTC 操作系统原理与设计 实验文档
本站展示中国科大操作系统原理与设计课的实验文档。目前只是把已有的文档直接放了上来,没有调整格式错误等。
临时搭出来的网站,目前还很不完善,请大家包涵。
请以课程主页上的信息为准:[课程主页](http://staff.ustc.edu.cn/~ykli/os2025/)
Loading