https://github.com/thu-pacman/lab-guide

Everything about PACMAN!
https://github.com/thu-pacman/lab-guide

Last synced: 2 months ago
JSON representation

Everything about PACMAN!

• Host: GitHub
• URL: https://github.com/thu-pacman/lab-guide
• Owner: thu-pacman
• Created: 2021-09-06T08:20:50.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-07-19T08:18:16.000Z (6 months ago)
• Last Synced: 2024-08-02T01:26:31.053Z (6 months ago)
• Size: 561 KB
• Stars: 11
• Watchers: 15
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# PACMAN Lab Guide

![Build documentation with mkdocs](https://github.com/thu-pacman/lab-guide/workflows/Build%20documentation%20with%20mkdocs/badge.svg)

本文档为 PACMAN 实验室指南，采用 `mkdocs` 编写。

本站点的自动编译版本在 [这里](https://pacman.cs.tsinghua.edu.cn/guide/) 发布。

本文档为公开发布，因此请不要在其中添加任何敏感信息，**尤其是任何的用户凭据**。

## 撰写

本站点内容使用 Markdown 进行编写。具体可查看 [mkdocs](https://www.mkdocs.org/) 和 [mkdocs-material](https://squidfunk.github.io/mkdocs-material/extensions/pymdown/) 文档。

如果创建了新页面，需要插入到 `mkdocs.yml` 的 `nav` 部分，否则将不会出现在编译结果中。

## 编译

首先安装依赖，而后编译即可：

```bash

python3 -m pip install --user -r requirements.txt # 安装 Python 依赖包

mkdocs serve # 直接在本地 serve，或者：

mkdocs build --clean # 生成于 site/ 文件夹中

```