rayeren / acad-homepage.github.io

AcadHomepage: A Modern and Responsive Academic Personal Homepage

AcadHomepage

| 中文文档

A Modern and Responsive Academic Personal Homepage

Some examples:

• Demo Page
• Personal Homepage of the author

Key Features

• Automatically update google scholar citations: using the google scholar crawler and github action, this REPO can update the author citations and publication citations automatically.
• Support Google analytics: you can trace the traffics of your homepage by easy configuration.
• Responsive: this homepage automatically adjust for different screen sizes and viewports.
• Beautiful and Simple Design: this homepage is beautiful and simple, which is very suitable for academic personal homepage.
• SEO: search Engine Optimization (SEO) helps search engines find the information you publish on your homepage easily, then rank it against similar websites.

Quick Start

1. Fork this REPO and rename to USERNAME.github.io, where USERNAME is your github USERNAME.
2. Configure the google scholar citation crawler:
   1. Find your google scholar ID in the url of your google scholar page (e.g., https://scholar.google.com/citations?user=SCHOLAR_ID), where SCHOLAR_ID is your google scholar ID.
   2. Set GOOGLE_SCHOLAR_ID variable to your google scholar ID in Settings -> Secrets -> Actions -> New repository secret of the REPO website with name=GOOGLE_SCHOLAR_ID and value=SCHOLAR_ID.
   3. Click the Action of the REPO website and enable the workflows by clicking "I understand my workflows, go ahead and enable them". This github action will generate google scholar citation stats data gs_data.json in google-scholar-stats branch of your REPO. When you update your main branch, this action will be triggered. This action will also be trigger 08:00 UTC everyday.
3. Generate favicon using favicon-generator and download all generated files to REPO/images.
4. Modify the configuration of your homepage _config.yml:
   1. title: the title of your homepage
   2. description: the description of your homepage
   3. repository: USER_NAME/REPO_NAME
   4. google_analytics_id (optional): google analytics ID
   5. SEO Related keys (optional): get these keys from search engine consoles (e.g. Google, Bing and Baidu) and paste here.
   6. author: the author information of this homepage, including some other websites, emails, city and univeristy.
   7. More configuration details are described in the comments.
5. Add your homepage content in _pages/about.md.
   1. You can use html+markdown syntax just same as jekyll.
   2. You can use a <span> tag with class show_paper_citations and attribute data to display the citations of your paper. Set the data to the google scholar paper ID. For

      <span class='show_paper_citations' data='DhtAFkwAAAAJ:ALROH1vI_8AC'></span>

      Q: How to get the google scholar paper ID?
      A: Enter your google scholar homepage and click the paper name. Then you can see the paper ID from citation_for_view=XXXX, where XXXX is the required paper ID.

6. Your page will be published at https://USERNAME.github.io.

Debug Locally

1. Clone your REPO to local using git clone.
2. Install Jekyll building environment, including Ruby, RubyGems, GCC and Make following the installation guide.
3. Run bash run_server.sh to start Jekyll livereload server.
4. Open http://127.0.0.1:4000 in your browser.
5. If you change the source code of the website, the livereload server will automatically refresh.
6. When you finish the modification of your homepage, commit your changings and push to your remote REPO using git command.

Acknowledges

• AcadHomepage incorporates Font Awesome, which is distributed under the terms of the SIL OFL 1.1 and MIT License.
• AcadHomepage is influenced by the github repo mmistakes/minimal-mistakes, which is distributed under the MIT License.
• AcadHomepage is influenced by the github repo academicpages/academicpages.github.io, which is distributed under the MIT License.

acad-homepage.github.io's Issues

请问如何更改字体呢？

已经试了之前问题的回答，但是不知道怎么更换全网站的字体，想请教一下，感谢！

Error

When deploying, facing this issue：

如何更改浏览器标签页图标

更新了自己的图片，但是浏览器标签页的小图标还是没变化

网页图标怎么改？

大家好，我按照作者教程中快速开始的第三步“使用 favicon-generator生成favicon（网页icon文件），并下载所有文件到REPO/images。”下载了新的图标，但是生成的网页的图标依然是默认的蓝底A字，请问这个要怎么改呢？

Anyway to add new sub-pages?

I have a question about adding new sub-pages to this template. I'd like to add a "Blog" section, I added a "Blog" section in the navigation.yml, and created a new blog.md file in _pages directory. I added "layout: default" in the .md file. However, the Blog page only appears basic characters without any formatting. Here is a screen capture:

Anyway to uniform the style of sub-pages with the front page? Thanks a lot!

Can't build the page anymore

I can't build the page anymore, I revert to previous versions commit but still can't, wonder if it happens to others too.

i got problem in add automatic update google scholar citation function.

I tried to add my google scholar citation using the format you left but the citation always shows the wrong number, can you help to figure it out? Thank you so much for your help!

Publication中部分会议名称显示与示例有出入

您好！我看您个人的主页中（非demo）的publications部分，对于没有图片的文献是这样写的：

- `ICLR 2023` [Bag of Tricks for Unsupervised Text-to-Speech](https://openreview.net/forum?id=SbR9mpTuBn), **Yi Ren**, Chen Zhang, Shuicheng Yan

其中ICLR 2023这种会议部分可以显示为蓝底白字的状态，但我在fork的demo程序中这样写并不能正常显示为和您的样式一样，请问是不是需要在配置文件中更改一些操作呢？
非常期待并感谢您的回复！

添加了docker编译环境，希望作者加进去。

我之前因为环境问题，一直编译不通过，所以做了个docker镜像，你可以考虑加进去。

1. 下载docker，具体可以参考官网
2. 在你的目标文件夹的终端运行代码 docker run -p 4000:4000 -v $(pwd):/site maxwelsdonc/acadhomepage，会自动下载镜像maxwelsdonc/acadhomepage
3. 修改run_server.sh文件内容为docker run --rm -p 4000:4000 -v $(pwd):/site maxwelsdonc/acadhomepage
4. 在你的目标文件夹的终端运行代码bash run_server.sh然后可以在http://localhost:4000中查看相应的网页。
5. 可以直接在源文件中进行修改，保存后刷新网页自动同步。
6. 退出后会自动删掉容器和相应的文件，只保留镜像就可以了。

Switch theme to dark mode

Hi Yi

I appreciate your work, and it is way nicer than the original version! But I wonder how to add a toggle in the top bar to easily switch across themes. Thanks!

Error of "Get Citation Data" workflow

When "Get Citation Data", workflow gets the error "Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: actions/checkout@v2. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.”

使用谷歌分析

How to chang the items on the Head Part?

Hi Renyi,

Thanks for your sharing github project of homepage. I have made my own homepage except the adjusted head part at https://chenq1114.github.io/. Through editing the navigation.yml file, I add the "Professional services" on the head part as below.

title: "Professional services"
url: "/#-services"

However, the new item cannot jump to the context normally. Would you please tell me how to fix it? Thank you very much!

Best,
Chen Qiu

how to add zhihu link?

About config.yml

I modify some info in config.yml and upload it to github, but the deploy web doesn't update these info. What should I do?

谷歌学术爬虫Action报错

可能和我修改过仓库的名称有关，现在不知道怎么运行了

how to add zhihu link?

How to add new page linked by the navigation bar

Is there a way to add new pages such as full pub list or blogs and be linked by the navigation bar at the top?

坐等star上千

我就是第一个issue

请问有中文版的开发计划吗？

感谢任意的贡献

请问下有中文版的开发计划吗？

期待回复，谢谢

关于本地调试环境配置

作者您好，很感谢您提供这个模板，但是在本地调试的时候会有一顿的环境配置问题，请问，能麻烦你用一个新的虚拟机或者其他之类，重新演示下配置过程吗，十分感谢！

How to change the font?

Hi, can I change the font style?

About google citations

Sorry, I cannot find the place where to enable the workflows. Could you please give me some suggestions?

加访问地图

作者您好，请问能否在主页加一个访客世界地图的功能

Why Get Citation Data Error?

]

衬线字体和中英文切换的建议

1、学术期刊中一般正文都用衬线字体，如 Times New Roman, Georgia，Latin Modern. 看着更学术一点，希望模板可以提供字体选择。
2、希望可以提供中英文切换，就像Github的Readme.md一样。

如何在 author_profile 中添加知乎主页链接图标

新人遇到bug -- Internal Server Error

本地调试的时候，http://127.0.0.1:4000， 出现

Internal Server Error
undefined method `key?' for nil:NilClass return unless @mime_types_charset.key?(typ) ^^^^^
WEBrick/1.8.1 (Ruby/3.1.3/2022-11-24) at 127.0.0.1:4000

terminal上显示
ERROR NoMethodError: undefined method key?' for nil:NilClass\n\n return unless @mime_types_charset.key?(typ)\n ^^^^^ /Users/kai/.gem/ruby/3.1.3/gems/jekyll-3.9.3/lib/jekyll/commands/serve/servlet.rb:191:in conditionally_inject_charset'
/Users/kai/.gem/ruby/3.1.3/gems/jekyll-3.9.3/lib/jekyll/commands/serve/servlet.rb:176:in do_GET' /Users/kai/.gem/ruby/3.1.3/gems/hawkins-2.0.5/lib/hawkins/servlet.rb:134:in do_GET'
/Users/kai/.gem/ruby/3.1.3/gems/webrick-1.8.1/lib/webrick/httpservlet/abstract.rb:105:in service' /Users/kai/.gem/ruby/3.1.3/gems/webrick-1.8.1/lib/webrick/httpservlet/filehandler.rb:242:in service'
/Users/kai/.gem/ruby/3.1.3/gems/webrick-1.8.1/lib/webrick/httpserver.rb:140:in service' /Users/kai/.gem/ruby/3.1.3/gems/webrick-1.8.1/lib/webrick/httpserver.rb:96:in run'
/Users/kai/.gem/ruby/3.1.3/gems/webrick-1.8.1/lib/webrick/server.rb:310:in `block in start_thread'

想问一下这该如何修改？