欢迎来到 AICompass！这是一个由人工智能学院同学共同建设的开放性学习平台。在这里，你可以：
- 获取课程学习资源
- 分享学习笔记心得
- 查阅往年考试资料
- 参与知识共创建设
https://sysu-saia.github.io/AICompass/
发邮件给热心网友
- 如果你对github不熟悉，或者你有不会挂载的大文件，可以将你要挂的文件、写好的markdown文件或者一些想法，打包发邮件到cuikq@mail2.sysu.edu.cn，几位热心网友可以帮你代为修改。
- 还是很推荐通过github贡献（下面的方法）！这样可以学习github的使用，并成为贡献者显示在仓库右侧！
Pull Request（推荐）
推荐通过PR（即Pull Request）的形式来进行贡献，具体流程：
- 在GitHub网页端点击右上角的fork，将本仓库fork到自己的账号下
- 在自己账号的对应仓库中进行修改
- 修改完成后，点击New pull request，提交一个PR
- 等待其他人审核、修改，然后合并到本repo中
本项目基于 Python 构建，请确保您的系统已安装 Python 环境。
git clone https://github.com/SYSU-SAIA/AICompass.git
cd AICompass创建虚拟环境
python -m venv venv激活虚拟环境
# Windows
venv\Scripts\activate
# Linux/MacOS
source venv/bin/activate
安装项目依赖
pip install -r requirements.txt#启动开发服务器
mkdocs serve此时可以访问http://127.0.0.1:8000 在本机查看文档
目前本站内容根据开课时间进行分组，然后再根据课程单独分页，每页内记录关于该课程的介绍、学习资料、学习技巧等。
在源代码层面，使用 markdown 进行编写，每一学期是一个文件夹，路径和网站链接路径保持一致，整体结构在 mkdocs.yml 文件中的 nav 部分定义。
mkdocs.yml是网站的配置文件，可修改网站的风格、添加拓展等。
.
├── .github/ # GitHub 相关配置
├── docs/ # 文档主目录
│ ├── FirstYear_1/ # 大一上学期
│ ├── FirstYear_2/ # 大一下学期
│ ├── SecondYear_1/ # 大二上学期
│ ├── stylesheets/ # 样式文件
│ ├── ContributionGuidelines.md # 贡献指南
│ ├── important-source.md # 重要资源
│ └── index.md # 主页
├── .gitignore # Git 忽略配置
├── mkdocs.yml # MkDocs 配置文件
├── model.md # 模型文档
├── README.md # 项目说明
└── requirements.txt # Python 依赖清单
欢迎为本网站做出贡献！您可以
- 完善或更新页面内容
- 添加新的课程页面
- 改进网站样式
Pull Request（推荐） 推荐通过 PR（即 Pull Request）的形式来进行贡献，具体流程：
- 在 GitHub 网页端点击右上角的 fork，将本仓库 fork 到自己的账号下
- 在自己账号的对应仓库中进行修改
- 修改完成后，点击 New pull request，提交一个 PR
- 等待其他人审核、修改，然后合并到本 repo 中
发邮件给热心网友 如果你对github不熟悉,或者你有不会挂载的大文件,可以将你要挂的文件、写好的markdown文件或者一些想法，打包发邮件到cuikq@mail2.sysu.edu.cn,几位热心网友可以帮你代为修改
- 在
docs目录下创建 markdown 文件 - 在
mkdocs.yml的nav部分添加页面路径，例如：
nav:
- 课程:
- 大一上:
- 高等数学1上: 'FirstYear_1/calculus1.md'- 保持客观性，理性介绍课程内容，请不要在本网站出现对老师本人的负面评价
- 课程笔记等请上传 PDF，建议多个文件打包整理
- 大文件(>1MB)请勿直接上传仓库
- 大文件挂载的方法请见下面的讲解
这样可以避免仓库体积过大，保持克隆和访问速度
!!! note 如何上传大文件？
- 优先使用外部资源链接
- 避免上传有版权内容（如课件） !!! note 新页面可以参考我们提供的模板。