# testground

**Repository Path**: upc-cs-fplab/testground

## Basic Information

- **Project Name**: testground
- **Description**: UPC-FPLab 在线实验指导书 测试站点
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-12-05
- **Last Updated**: 2023-12-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 关于本站

这是UPC **FPLab** 的测试站点,用于测试在线实验指导书整体显示效果

下面我将介绍一下 **如何参与到站点的编辑**

请根据自己的角色阅读下面的指南

## 面向内容创作者

您可以直接将`docs`目录视为您的工作目录,然后随意按照您的想法组织文件夹结构(但这不是最终显示的目录结构),讲义需要使用Markdown进行书写,您可能需要简单学习一下Markdown语法([教程](https://markdown.com.cn/basic-syntax/),推荐的[编辑器](https://typora.io/)),另外您还可以参考本站里哈工深样例测试(即`docs/test/hit.md`文件),里面有更加丰富的语法.


> TODO: 介绍更加详细的语法? 其实我觉得可以本地使用typora编写好(包括管理图片等资源),然后再专人适配一下mkdocs

编写完成讲义后,您需要编辑`mkdocs.yml`文件中`nav`一值,来修改最终显示的目录结构

之后您还需要构建(build)和部署,这可能比较困难,可以在完成编辑后,寻求开发维护人员的帮助.

## 面向开发维护人员

站点基于[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)框架,请直接 **参考其[官方文档](https://squidfunk.github.io/mkdocs-material/getting-started/)**

clone本项目之后,在虚拟环境中安装本项目依赖:

```shell
pip install -r requirements.txt
```

激活虚拟环境

```shell
. .venv/bin/activate
```

之后参考Material for MkDocs文档,通过下面的命令在本地运行测试:

```shell
mkdocs serve
```

构建站点,运行下面的命令:

```shell
mkdocs build
```

欢迎PR&Star