Skip to content

Commit 9daba4c

Browse files
committed
Add GitHub Pages course docs site
1 parent f3d0dd5 commit 9daba4c

22 files changed

Lines changed: 10010 additions & 4 deletions

.github/workflows/deploy.yml

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Deploy site
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: false
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v4
23+
24+
- name: Setup Node
25+
uses: actions/setup-node@v4
26+
with:
27+
node-version: 20
28+
cache: npm
29+
cache-dependency-path: site/package-lock.json
30+
31+
- name: Install dependencies
32+
working-directory: site
33+
run: npm ci
34+
35+
- name: Check
36+
working-directory: site
37+
run: npm run check
38+
39+
- name: Build
40+
working-directory: site
41+
run: npm run build
42+
43+
- name: Check links
44+
working-directory: site
45+
run: npm run check:links
46+
47+
- name: Configure Pages
48+
uses: actions/configure-pages@v5
49+
50+
- name: Upload artifact
51+
uses: actions/upload-pages-artifact@v4
52+
with:
53+
path: site/dist
54+
55+
deploy:
56+
environment:
57+
name: github-pages
58+
url: ${{ steps.deployment.outputs.page_url }}
59+
runs-on: ubuntu-latest
60+
needs: build
61+
steps:
62+
- name: Deploy to GitHub Pages
63+
id: deployment
64+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22
* text=auto
33
final_product/data/
44
/finial_product/data
5+
site/node_modules/
6+
site/dist/
7+
site/.astro/
8+
site/public/content-assets/
9+
site/src/data/content.json
10+
site-preview.*.log

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
中文 | [English](README_EN.md)
2+
3+
## 在线文档站
4+
5+
### [点击这里打开网页版课程文档](https://nightt5879.github.io/FPGA/zh/)
6+
7+
建议优先阅读网页版,图片、PDF、实验章节、ZedBoard / AX7010 内容和勘误都已经按页面整理好。
8+
29
- [数字集成电路前端设计与高层次综合](#数字集成电路前端设计与高层次综合)
310
- [1.写在前面](#1写在前面)
411
- [1.1 软件硬件环境](#11-软件硬件环境)
@@ -50,7 +57,7 @@
5057

5158
**ZedBoard资料**
5259
- [ZedBoard原理图](./datasheet/AVNET%20Zedboard/zedbaord%20原理图.pdf)
53-
- [ZedBoard Zynq-7000 ARM FPGA进阶手册](./datasheet/AVNET%20Zedboard/ZedBoard%20Zynq-7000%20ARM%20FPGA进阶手册.pdf)
60+
- [ZedBoard Zynq-7000 ARM FPGA进阶手册](./datasheet/AVNET%20Zedboard/ZedBoard%20%20Zynq-7000%20ARM%20FPGA进阶级处理器%20全可编程逻辑智能互联开发系统%20用户手册.pdf)
5461
- [ZedBoard用户硬件手册](./datasheet/AVNET%20Zedboard/zedboard%20用户硬件手册.pdf)
5562
- [ZedBoard Schematic](./datasheet/AVNET%20Zedboard/ZedBoard_Schematic.pdf)
5663
- [ZedBoard上手手册](./datasheet/AVNET%20Zedboard/zedboard上手手册.pdf)
@@ -476,7 +483,7 @@ clogb2(DIVIDER)的作用是计算DIVIDER的二进制位数,这样就可以得
476483
## 4.HLS_lab
477484
## 4.1 实验1
478485
这个实验可以注意到有很多个版本,首先是最原始的使用vivadoHLS的版本,这个适用较老的工具。其次是Vitis HLS的版本,这个适用于较新的工具。还有最新的Vitis版本,这个版本我使用跑完了实验1同时有一个教学文档。</p>
479-
> **Vitis的教学文档** [Vitis开发lab1](./datasheet/lab1_vitis.pdf)
486+
> **Vitis的教学文档** [Vitis开发lab1](./datasheet/High-Level-Synthesis-Flow-on-Zynq-using-Vivado-HLS/Vitis/Lab1.pdf)
480487
## 4.2 实验2
481488
可与使用强制命令打开Vitis_HLS软件的项目,使用代码:</p>
482489
```

README_EN.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
[中文](README.md) | English
2+
3+
## Online Documentation Site
4+
5+
### [Click here to open the course website](https://nightt5879.github.io/FPGA/en/)
6+
7+
The website is the recommended reading path. Images, PDFs, lab sections, ZedBoard / AX7010 notes, and errata are organized as browsable pages.
8+
29
- [Front-end Design of Digital Integrated Circuits and High-level Synthesis](#front-end-design-of-digital-integrated-circuits-and-high-level-synthesis)
310
- [1. Preface](#1-preface)
411
- [1.1 Software and Hardware Environment](#11-software-and-hardware-environment)
@@ -52,7 +59,7 @@ The purpose of this project is, firstly, to complete the six labs and the course
5259

5360
**ZedBoard Documentation**
5461
- [ZedBoard Schematic Diagram](./datasheet/AVNET%20Zedboard/zedbaord%20原理图.pdf)
55-
- [ZedBoard Zynq-7000 ARM FPGA Advanced Manual](./datasheet/AVNET%20Zedboard/ZedBoard%20Zynq-7000%20ARM%20FPGA进阶手册.pdf)
62+
- [ZedBoard Zynq-7000 ARM FPGA Advanced Manual](./datasheet/AVNET%20Zedboard/ZedBoard%20%20Zynq-7000%20ARM%20FPGA进阶级处理器%20全可编程逻辑智能互联开发系统%20用户手册.pdf)
5663
- [ZedBoard User Hardware Manual](./datasheet/AVNET%20Zedboard/zedboard%20用户硬件手册.pdf)
5764
- [ZedBoard Schematic](./datasheet/AVNET%20Zedboard/ZedBoard_Schematic.pdf)
5865
- [ZedBoard Getting Started Guide](./datasheet/AVNET%20Zedboard/zedboard上手手册.pdf)
@@ -506,7 +513,7 @@ This experiment primarily teaches how to use Debug for troubleshooting, and the
506513
### 4.1 Experiment 1
507514
This experiment has several versions. First, there is the original version using Vivado HLS, which is suitable for older tools. Then, there is the Vitis HLS version, which is for newer tools. Finally, there is the latest version for Vitis, which I used to complete Experiment 1, and I have also prepared a tutorial document for it.
508515

509-
> **Vitis Tutorial Document** [Vitis Lab 1 Development](./datasheet/lab1_vitis.pdf)
516+
> **Vitis Tutorial Document** [Vitis Lab 1 Development](./datasheet/High-Level-Synthesis-Flow-on-Zynq-using-Vivado-HLS/Vitis/Lab1.pdf)
510517
511518
### 4.2 Experiment 2 (Linux issues)
512519
### 4.3 Experiment 3 (Linux issues)

site/astro.config.mjs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
import { defineConfig } from "astro/config";
2+
import mdx from "@astrojs/mdx";
3+
import react from "@astrojs/react";
4+
5+
export default defineConfig({
6+
site: "https://nightt5879.github.io",
7+
base: "/FPGA",
8+
integrations: [react(), mdx()],
9+
});

0 commit comments

Comments
 (0)