学术页面是一个基于GitHub Pages的模板,适用于个人和专业作品集导向的网站。
- 如果没有GitHub账户,请先注册并确认电子邮件(必需!)
- 点击右上角的"使用此模板"按钮。
- 在"新建仓库"页面,将仓库名称设置为"[你的GitHub用户名].github.io",这将是你的网站URL。
- 进行全站配置并添加你的内容。
- 将任何文件(如PDF、.zip文件等)上传到
files/目录。它们将出现在https://[你的GitHub用户名].github.io/files/example.pdf。 - 在仓库设置的"GitHub Pages"部分查看状态。
- (可选)使用
markdown_generator文件夹中的Jupyter notebooks或python脚本从TSV文件生成出版物和演讲的markdown文件。
更多信息请访问 https://academicpages.github.io/
在最初开发网站时,能够在推送到GitHub之前在本地预览更改非常有用。要在本地工作,你需要:
- 克隆仓库并按照上述步骤进行更新。
-
确保已安装 ruby-dev、bundler 和 nodejs
在大多数Linux发行版和Windows子系统Linux上,命令是:
sudo apt install ruby-dev ruby-bundler nodejs
如果看到错误
无法定位软件包 ruby-bundler或无法定位软件包 nodejs,请运行以下命令:sudo apt update && sudo apt upgrade -y然后再次尝试运行
sudo apt install ruby-dev ruby-bundler nodejs。在 MacOS 上的命令是:
brew install ruby brew install node gem install bundler
-
运行
bundle install以安装 Ruby 依赖项。如果出现错误,请删除 Gemfile.lock 并重试。如果看到文件权限错误,如
Fetching bundler-2.6.3.gem ERROR: While executing gem (Gem::FilePermissionError) You don't have write permissions for the /var/lib/gems/3.2.0 directory.或Bundler::PermissionError: There was an error while trying to write to /usr/local/bin.本地安装Gems(推荐):bundle config set --local path 'vendor/bundle'
然后再次尝试运行
bundle install。如果成功,你应该会看到一个名为vendor的文件夹,打开.gitignore并将vendor添加进去。 -
运行
jekyll serve -l -H localhost生成HTML并从localhost:4000提供服务,本地服务器会在更改时自动重建并刷新页面。 你也可以尝试bundle exec jekyll serve -l -H localhost,以确保jekyll使用你本地机器上的特定依赖项。
如果你在Linux上运行,可能需要先安装一些额外的依赖项才能本地运行:sudo apt install build-essential gcc make
在不同的操作系统上工作,或者只是想避免安装依赖项?如果你已经安装了Docker,你可以使用提供的Dockerfile构建一个容器来为你运行网站。
你可以通过在仓库中运行以下命令来构建和执行容器:
chmod -R 777 .
docker compose up现在您应该能够从 localhost:4000 访问该网站。
如果您正在使用 Visual Studio Code,您可以使用此存储库附带的 Dev Container。通常情况下,VS Code 会检测到有可用的开发容器配置,并询问您是否要使用该容器。如果没有发生这种情况,您可以手动通过 F1->DevContainer: Reopen in Container 启动容器。这会在容器中重新启动您的 VS Code,并自动在 http://localhost:4000 上本地托管您的学术页面。所有更改将在几秒钟内实时更新到该页面。
模板的错误报告和功能请求应通过GitHub提交。关于如何设置模板样式的问题,请随时在GitHub上发起新讨论。
该仓库由Stuart Geiger从Minimal Mistakes Jekyll主题fork(然后分离),该主题© 2016 Michael Rose,并在MIT许可证下发布(见LICENSE.md)。目前由Robert Zupko维护,欢迎更多维护者加入。
如果你有想要作为pull request提交的错误修复和增强,你需要fork该仓库,而不是将其作为模板使用。这也允许你将模板的副本同步到你的fork。
不幸的是,像学术页面这样的模板主题存在一个后勤问题,这使得获取核心主题的错误修复和更新变得有点棘手。如果你使用此模板并自定义它,在尝试同步时可能会遇到合并冲突。如果你想保存你的各种.yml配置文件和markdown文件,你可以删除仓库并重新fork。或者你可以手动打补丁。
