VLSI课程作业代码仓库。
对应课程网页链接。
本课程的作业由 4 个任务组成:
链接给出各自实验的具体要求。
面向后面接手这个项目的助教,或其他参考本项目的课程代码设计实践。
采用docisfy部署文档静态网页。
需要使用NPM进行安装,NPM安装这里找到对应版本,本项目使用nodejs的版本为v22.11.0,npm的版本为11.1.0,docsify的版本为4.13.1。
使用npm install docsify安装docsify包,安装完成后在终端执行以下指令:
docsify如果出现以下内容说明安装完成:
Usage: docsify <init|serve> <path>
Commands:
docsify init [path] Creates new docs [aliases: i]
docsify serve [path] Run local server to preview site. [aliases: s]
docsify start <path> Server for SSR
docsify generate <path> Docsify's generators [aliases: g]
Global Options
--help, -h Show help [boolean]
--version, -v Show version number [boolean]
Documentation:
https://docsifyjs.github.io/docsify
https://docsifyjs.github.io/docsify-cli
Development:
https://github.com/docsifyjs/docsify-cli/blob/master/CONTRIBUTING.md
[ERROR] 0 arguments passed. Please specify a command这时候cd到库的/docs目录下,使用指令docsify init初始化目录,然后执行docsify s在本地启动web服务,打开http://localhost:3000就可以看到文档了。
建议按照html写法插入图片。其中用[]括起来的部分根据实际情况填写。需要在本地检查确定图片插入正常,大小合适。
<img width=[250] alt="[any-title]" src="[/lab1/img/xxx.jpg]" style="margin:auto; display:flex;">注意,正式部署前需要在所有的src关键字插入远程库名以保证部署后能正确引用图片。
例如本代码仓库的名字叫做VLSI-FPGA,假设图片在本地部署时路径为/lab1/img/xxx.jpg(注意是相对路径),那么改成以下形式:
<img width=250 alt="any-title" src="/lab1/img/xxx.jpg" style="margin:auto; display:flex;">
改成以下形式
<img width=250 alt="any-title" src="/VLSI-FPGA/lab1/img/xxx.jpg" style="margin:auto; display:flex;">此时本地预览会提示图片路径错误,这是正常的。因此务必确保在本地预览时图片正确显示,然后再修改src关键字。
建议新章节除了文件标题用一级标题外,其他位置不使用一级标题。
假设将来有作业4,在docs目录下创建一个lab4文件目录,在lab4内部创建img目录用于存放lab4的图片,然后创建markdown文件。
形成的结构目录如下所示:
/docs
|--- ...
|--- lab3/
| |--- img/
| |--- lab3_problem.md
|--- lab4/
|--- img/
|--- lab4_problem.md然后为新章节加入访问入口。打开/docs/_sidebar.md文件,找一个合适的位置添加入口,并添加连接。
打开/docs/README.md文件,修改其中内容。
比如修改侧边栏的标题层级、主题等,建议参考docsify文档。
检查对应作业文档。