Academic Template for Hugo
The Hugo Academic Resumé Template empowers you to create your job-winning online resumé and showcase your academic publications.
Check out the latest demo of what you'll get in less than 10 minutes, or view the showcase.
Wowchemy makes it easy to create a beautiful website for free. Edit your site in Markdown, Jupyter, or RStudio (via Blogdown), generate it with Hugo, and deploy with GitHub or Netlify. Customize anything on your site with widgets, themes, and language packs.
- 👉 Get Started
- 📚 View the documentation
- 💬 Chat with the Wowchemy community or Hugo community
- 🐦 Twitter: @wowchemy @GeorgeCushen #MadeWithWowchemy
- 💡 Request a feature or report a bug for Wowchemy
- ⬆️ Updating Wowchemy? View the Update Guide and Release Notes
To help us develop this template and software sustainably under the MIT license, we ask all individuals and businesses that use it to help support its ongoing maintenance and development via sponsorship.
- Hugo Academic CLI: Automatically import publications from BibTeX
- Install Hugo
- Download hugo_extended_VERSION_Linux-64bit.deb from https://github.com/gohugoio/hugo/releases. Note that you have to get the extended version for the website based on Wowchemy template to work.
- Double click the .deb to install Hugo.
- Install Hugo's Go dependency, in a terminal
sudo snap install --classic go
- Install the Hugo Academic CLI, in a terminal
pip3 install -U academic
- Clone the repository from my Github, in a terminal
git clone [email protected]:zhanlilz/zhanlilz.github.io.git
There are three branches,
- Branch
master
: where I work on my website. Any changes made here are not deployed on my actual personal website. I should preview changes here using the scriptview.sh
in the top directory. - Branch
ready
: where I merge proofed changes from the branchmaster
. Any changes made here will trigger a Github workflow calledgh-pages.yml
that is saved under.github/workflows/
. This workflow will generate the actual website files (all the HTML, CSS and such) and save/update them on the branchgh-pages
. - Branch
gh-pages
: where the actual website files are stored and served by the Github Pages online under the URL of my personal webpage, https://zhanlilz.github.io/
- Preview the website, ini a terminal
# In the top directory of the website repository ./view.sh
- Update the Wowchemy website components that my website uses, refer to https://wowchemy.com/docs/hugo-tutorials/update/
-
content/publications: Add a pdf under a publication folder (e.g., li-2018) named after this publication folder name (i.e., li-2018.pdf under content/publication/li-2018). The pdf button on the publication page will give users the pdf.
-
static/sub-folder-name: Files under this folder can be referred in the .md files as sub-folder-name/a-file
-
menus.yaml: Change the
weight
property of each menu item to change its display location on top of the home page. The larger the weight, the more right / further back the item will be displayed. -
content/home/tags.md: This is the word cloud displayed under "Popular Topics" on the published page. It uses tags in all the .md files. Currently, most tags are from the index.md files in the publication folders.
-
Create a new post. For more details, https://wowchemy.com/docs/content/blog-posts/
$ hugo new --kind post post/my-article-name
-
Create a new publication. For more details, https://wowchemy.com/docs/content/publications/
- Import from a .bib file
$ academic import --bibtex <path_to_your/publications.bib>
- Mannually create one
$ hugo new --kind publication publication/<my-publication>
- Import from a .bib file
-
Highlight an author name.
- Edit the file
content/authors/<first_name>-<last_name>/_index.md
. In the front matter of the .md file, add/changehighlight_name: true
. If the author name in the index.md file of a publication appears as "first_name last_name", then this author name will be automatically recognized as the author in the foldercontent/authors/<first_name>-<last_name>
. Otherwise, you need to use<first_name>-<last_name>
in the index.md file of a publication. - Tip: according to https://wowchemy.com/docs/getting-started/get-started/,
usernames (names of the folders under
content/authors/
) must be lowercase with any spaces replaced with hyphens (-).
- Edit the file
-
Disable/Enable a widget (or visually a section on my website) For example, to disable the section Post,
- go to
content/home/posts.md
, look for the following two linesIf# Activate this widget? true/false active: false
active: false
, the widget/section will not show on the website. Ifactive: true
, it will show. - Do NOT forget to edit
config/_default/menus.yaml
to remove this section from the top menu if it was an item on the menu.
- go to