本网站基于Hugo Academic 模板构建
本项目基于Hugo和Academic主题。Hugo是基于GO语言的一个开源网站生成工具,使用Hugo可以从简单的MarkDown文件生成网页页面,而不必处理复杂的HTML CSS JS。Academic主题是转为科研团队设计的一款Hugo主题。
注册Gitee, 联系仓库管理员添加成为协作者。
配置SSH密钥
win10系统应首先检查OpenSSH Client是否开启:
下一步,在桌面按shift+右键,选择“在此处打开Powershell窗口”:
键入:
ssh-keygen -t rsa -C "xxxxx@xxxxx.com"
这里的 xxxxx@xxxxx.com
只是生成的 sshkey 的名称,并不约束或要求具体命名为某个邮箱,但建议使用注册Gitee的邮箱。连按三次回车,即可生成 ssh key。
生成的密钥存放在C:\Users\【用户名】\.ssh
记事本打开id_rsa.pub,复制其中的内容,粘贴到Gitee:
通过主页-设置-SSH公钥,添加生成的 public key 到个人账户中。
安装Go。Go是Hugo的依赖,在此处下载Go安装包进行安装。
安装Hugo。在此处下载ZIP文件,解压,将其中的hugo.exe放入C:\Program Files\Hugo,打开环境变量:
添加C:\Program Files\Hugo项:
安装Git,在此处下载安装包并安装
克隆本项目到本地:
在选定的文件夹中,按shift+右键,选择“在此处打开Powershell窗口”:
在Powershell中输入下面的命令,回车执行,将本项目拉至本地
git clone https://gitee.com/leidawt/bit-pse.git
在Powershell中输入下面的命令,回车执行,配置自己的git信息
git config --global user.email "替换为你的邮箱"
git config --global user.name "替换为用户名"
此处填写的信息将用于git系统确定提交者。
下载安装vscode编辑器用于代码编辑
至此环境准备工作结束。
对网站内容进行增删、编辑的流程如下:
下面以编辑个人信息为例进行详细说明:
在本例中,我们在个人介绍中添加一行内容“Hello World”。
首先使用Vscode打开项目文件夹,打开目标文件:
首先使用git pull将最新项目文件更新本地:
按 “ctrl” + “~键”开启终端,键入下述命令并回车:
git pull origin master
如提示如下信息:
则先执行:
git remote set-url origin git@gitee.com:leidawt/bit-pse.git
然后再进行:
git pull origin master
成功同步后,即可开始编辑和修改目标文件:
【注】:项目路径结构和内容维护的详细说明见随后章节
为编辑和修改的测试效果,可启动预览服务器预览。
按 “ctrl” + “~键”开启终端,键入下述命令并回车:
hugo server
使用浏览器打开http://localhost:1313 即可对当前修改结果进行预览。此时hugo server 会自动侦测源文件变动自动刷新页面,可实现实时预览。按“ctrl”+"C"可关闭预览服务器。
完成所需编辑后,编译网站。
按 “ctrl” + “~键”开启终端,键入下述命令并回车:
hugo
如得到类似上图的结果,则编译成功。
下面开始提交更改。
首先使用git add将暂存区的变更添加到提交:
按 “ctrl” + “~键”开启终端,键入下述命令并回车:
git add *
使用git commit -m "提交日志"提交新版本。
按 “ctrl” + “~键”开启终端,键入下述命令并回车:
git commit -m "xxx"
其中"xxx"应替换为此次提交的简要说明,一般不超过20字,例如:“添加新文献”
最后,使用git push将本地修改同步到远程。
按 “ctrl” + “~键”开启终端,键入下述命令并回车:
git push origin master
至此,我们已将变更成功提交到gitee,请告知管理员刷新网站。
项目部署在gitee pages。leidawt/bit-pse-public
编译并上传静态文件
deploy.bat
更新gitee pages
对内容的维护只需关注content\en和content\zh文件夹,分别存放有网站英文版和中文版的内容,其结构为:
authors存放成员介绍,posts存放博文,project存放项目介绍,publication存放论文。home则描述网站各子模块的配置信息结构,一般不需变动。
论文存放在content\en\publication文件夹和content\zh\publication文件夹中,分别为英文/中文版本,每篇文章由一个文件夹构成,其中包括描述文件index.md和该文的相关资源,如bib,pdf,代码,数据集。
使用此方法需要有Python3运行环境。安装如下软件包
pip3 install -U academic
开启命令行,进入网站源码目录,执行
academic import --bibtex <path_to_your/publications.bib>
这将在content\publication文件夹下生成由作者和标题为名的文件夹(如:content\publication\jia-decomposition-aggregation-based-real-time-2020),其中包括cite.bib和index.md文件,文章相关的摘要或说明可在index.md文件的末尾填写:
进入content\en\publication文件夹,将content\en\publication\jia-performance-analysis-assembly-2016 复制一份进行修改。注意确保文件夹命名的唯一性,并避免出现中文字符,推荐的命名方法是“一作姓-简要标题-年份”。
编辑文件夹中的index.md文件:
特别的,文章类型publication_types字段应填写如下之一的选项:
选取一张封面图,将其命名为featured.png,存放于对应的文献文件夹(例如:\content\publication\jia-closed-bernoulli-lines-2019\featured.png)即可,其效果是:
将所需pdf文件重命名为文献文件夹的名称,并拷贝到文献文件夹中即可。
将代码压缩为code.zip复制到文献文件夹即可
pdf、代码的显示效果如下所示:
复制一份content\en\authors\Zhiyang Jia,到content\authors\,并以作者名字重命名。
【注】中文版则是content\zh\authors\Zhiyang Jia
将avatar.jpg替换为头像照片,尺寸必须为400px*400px,格式可以是png或jpg
用文本编辑器(如vscode)编辑_index.md文件并替换相应内容。
注意:
superuser字段填入false
user_groups字段,学生填写Researchers,已毕业学生填写Alumni,老师填写Principal Investigators
显示效果如下:
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。