3 Star 0 Fork 0

leidawt / bit-pse

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

实验室网站维护说明

本网站基于Hugo Academic 模板构建

Wowchemy Website Builder

  1. 本网站源码托管在leidawt的gitee仓库https://gitee.com/leidawt/bit-pse
  2. 本网站使用git进行版本管理和协同开发,请使用pull request提交更新,关于git版本管理工具使用及协作开发方法请详见 https://www.liaoxuefeng.com/wiki/896043488029600
  3. Hugo Academic模板由一系列markdown文本文件构成,推荐使用VsCode进行开发工作:https://code.visualstudio.com/
  4. 若编译本网站,请使用Hugo 0.75.1或更高版本

编译与调试

环境准备(Windows)

本项目基于Hugo和Academic主题。Hugo是基于GO语言的一个开源网站生成工具,使用Hugo可以从简单的MarkDown文件生成网页页面,而不必处理复杂的HTML CSS JS。Academic主题是转为科研团队设计的一款Hugo主题。

  1. 注册Gitee, 联系仓库管理员添加成为协作者。

  2. 配置SSH密钥

    win10系统应首先检查OpenSSH Client是否开启:

    image-20210315111214150

    image-20210315111304116

    下一步,在桌面按shift+右键,选择“在此处打开Powershell窗口”:

    image-20210308232308312

    键入:

    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 到个人账户中。

    image-20210316162221169

    image-20210316162323021

  3. 安装Go。Go是Hugo的依赖,在此处下载Go安装包进行安装。

  4. 安装Hugo。在此处下载ZIP文件,解压,将其中的hugo.exe放入C:\Program Files\Hugo,打开环境变量:

    image-20210308231525253 image-20210308231615007

    添加C:\Program Files\Hugo项:

    image-20210308231729809
    1. 安装Git,在此处下载安装包并安装

    2. 克隆本项目到本地:

      在选定的文件夹中,按shift+右键,选择“在此处打开Powershell窗口”:

      image-20210308232308312

      在Powershell中输入下面的命令,回车执行,将本项目拉至本地

      git clone https://gitee.com/leidawt/bit-pse.git

      在Powershell中输入下面的命令,回车执行,配置自己的git信息

      git config --global user.email "替换为你的邮箱"
      git config --global user.name "替换为用户名"

      此处填写的信息将用于git系统确定提交者。

    3. 下载安装vscode编辑器用于代码编辑

至此环境准备工作结束。

开发流程

对网站内容进行增删、编辑的流程如下:

  1. 使用git pull将最新项目文件更新本地
  2. 编辑和修改
  3. 编译网站(检查)
  4. 使用git add将暂存区的变更添加到提交
  5. 使用git commit -m "提交日志"提交新版本
  6. 使用git push将本地修改同步到远程
  7. 告知管理员刷新网站

例子

下面以编辑个人信息为例进行详细说明:

在本例中,我们在个人介绍中添加一行内容“Hello World”。

首先使用Vscode打开项目文件夹,打开目标文件:

image-20210309001508556

首先使用git pull将最新项目文件更新本地:

按 “ctrl” + “~键”开启终端,键入下述命令并回车:

git pull origin master

image-20210316162616104

如提示如下信息:

image-20210316162707376

则先执行:

git remote set-url origin git@gitee.com:leidawt/bit-pse.git

然后再进行:

git pull origin master

成功同步后,即可开始编辑和修改目标文件:

【注】:项目路径结构和内容维护的详细说明见随后章节

image-20210309002134003

为编辑和修改的测试效果,可启动预览服务器预览。

按 “ctrl” + “~键”开启终端,键入下述命令并回车:

hugo server

image-20210309002501018

image-20210309002521611

使用浏览器打开http://localhost:1313 即可对当前修改结果进行预览。此时hugo server 会自动侦测源文件变动自动刷新页面,可实现实时预览。按“ctrl”+"C"可关闭预览服务器。

完成所需编辑后,编译网站。

按 “ctrl” + “~键”开启终端,键入下述命令并回车:

hugo

image-20210309002549281

如得到类似上图的结果,则编译成功。

下面开始提交更改。

首先使用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

image-20210322164646853

项目结构

image-20210316163700889

对内容的维护只需关注content\en和content\zh文件夹,分别存放有网站英文版和中文版的内容,其结构为:

image-20210316163831884

authors存放成员介绍,posts存放博文,project存放项目介绍,publication存放论文。home则描述网站各子模块的配置信息结构,一般不需变动。

添加新论文的方法

论文存放在content\en\publication文件夹和content\zh\publication文件夹中,分别为英文/中文版本,每篇文章由一个文件夹构成,其中包括描述文件index.md和该文的相关资源,如bib,pdf,代码,数据集。

方法1:借助脚本自动添加(由bib文件自动生成)

使用此方法需要有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文件的末尾填写:

image-20201111145927292

方法2:手动编写

进入content\en\publication文件夹,将content\en\publication\jia-performance-analysis-assembly-2016 复制一份进行修改。注意确保文件夹命名的唯一性,并避免出现中文字符,推荐的命名方法是“一作姓-简要标题-年份”。

编辑文件夹中的index.md文件:

image-20210316165150662

特别的,文章类型publication_types字段应填写如下之一的选项:

  • 0 = Uncategorized
  • 1 = Conference paper
  • 2 = Journal article
  • 3 = Preprint / Working Paper
  • 4 = Report
  • 5 = Book
  • 6 = Book section
  • 7 = Thesis (v4.2+ required)
  • 8 = Patent (v4.2+ required)

补充封面图片、代码、pdf等资源的方法

添加封面图片的方法

选取一张封面图,将其命名为featured.png,存放于对应的文献文件夹(例如:\content\publication\jia-closed-bernoulli-lines-2019\featured.png)即可,其效果是:

image-20210316165552883

image-20201111150702825

添加pdf下载链接的方法

将所需pdf文件重命名为文献文件夹的名称,并拷贝到文献文件夹中即可。

添加源码文件下载链接的方法

将代码压缩为code.zip复制到文献文件夹即可

pdf、代码的显示效果如下所示:

image-20201111150815472

添加新成员的方法

复制一份content\en\authors\Zhiyang Jia,到content\authors\,并以作者名字重命名。

【注】中文版则是content\zh\authors\Zhiyang Jia

将avatar.jpg替换为头像照片,尺寸必须为400px*400px,格式可以是png或jpg

用文本编辑器(如vscode)编辑_index.md文件并替换相应内容。

注意:

  1. superuser字段填入false

    image-20201111151917412

  2. user_groups字段,学生填写Researchers,已毕业学生填写Alumni,老师填写Principal Investigators

显示效果如下:

image-20201111153414489

image-20201111153527666

MIT License Copyright (c) 2016-present George Cushen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

实验室网站hugo工程 PSE lab of Beijing Institute of Technology 展开 收起
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/leidawt/bit-pse.git
git@gitee.com:leidawt/bit-pse.git
leidawt
bit-pse
bit-pse
master

搜索帮助

53164aa7 5694891 3bd8fe86 5694891