| 中文文档
A Modern and Responsive Academic Personal Homepage
Some examples:
- 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.
- Fork this REPO and rename to
USERNAME.github.io
, whereUSERNAME
is your github USERNAME. - Configure the google scholar citation crawler:
- 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. - Set GOOGLE_SCHOLAR_ID variable to your google scholar ID in
Settings -> Secrets -> Actions -> New repository secret
of the REPO website withname=GOOGLE_SCHOLAR_ID
andvalue=SCHOLAR_ID
. - 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 datags_data.json
ingoogle-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.
- Find your google scholar ID in the url of your google scholar page (e.g., https://scholar.google.com/citations?user=SCHOLAR_ID), where
- Generate favicon using favicon-generator and download all generated files to
REPO/images
. - Modify the configuration of your homepage
_config.yml
:title
: the title of your homepagedescription
: the description of your homepagerepository
: USER_NAME/REPO_NAMEgoogle_analytics_id
(optional): google analytics ID- SEO Related keys (optional): get these keys from search engine consoles (e.g. Google, Bing and Baidu) and paste here.
author
: the author information of this homepage, including some other websites, emails, city and univeristy.- More configuration details are described in the comments.
- Add your homepage content in
_pages/about.md
.- You can use html+markdown syntax just same as jekyll.
- You can use a
<span>
tag with classshow_paper_citations
and attributedata
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 fromcitation_for_view=XXXX
, whereXXXX
is the required paper ID.
- Your page will be published at
https://USERNAME.github.io
.
_data/navigation.yml 里面来改导航栏 ·每次change之后要想修改必须在settings -> pages 重新选择branch重新部署
·点击actions 并选择jelly deploy...
- Clone your REPO to local using
git clone
. - Install Jekyll building environment, including
Ruby
,RubyGems
,GCC
andMake
following the installation guide. - Run
bash run_server.sh
to start Jekyll livereload server. - Open http://127.0.0.1:4000 in your browser.
- If you change the source code of the website, the livereload server will automatically refresh.
- When you finish the modification of your homepage,
commit
your changings andpush
to your remote REPO usinggit
command.
- 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.