https://github.com/thu-cs-lab/Digital-Design-Docs

Documentation for Digital Design course
https://github.com/thu-cs-lab/Digital-Design-Docs

Last synced: 2 months ago
JSON representation

Documentation for Digital Design course

• Host: GitHub
• URL: https://github.com/thu-cs-lab/Digital-Design-Docs
• Owner: thu-cs-lab
• Created: 2020-05-18T14:09:42.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-13T15:11:32.000Z (9 months ago)
• Last Synced: 2024-04-13T22:21:50.401Z (9 months ago)
• Language: Verilog
• Homepage:
• Size: 8.87 MB
• Stars: 19
• Watchers: 7
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Digital Design Documentation

![Build documentation with mkdocs](https://github.com/thu-cs-lab/Digital-Design-Docs/workflows/Build%20documentation%20with%20mkdocs/badge.svg)

本项目为数字逻辑实验课程的实验文档，采用 `mkdocs` 编写。

本站点的自动编译版本在 [这里](https://lab.cs.tsinghua.edu.cn/digital-design/doc/) 发布。

## 撰写

本站点内容使用 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/ 文件夹中

```