This is the source code for my personal webpage.
The code is based on the Academic framework for Hugo. This framework allows you to never touch HTML/CSS to build your own website. I simplified and streamlined the theme significantly to match the type of personal webpages you would find in the Machine Learning community. You can check out the original demo of Academic or its official documentation.
In this README I will re-iterate the very basics needed to get started, mostly for my own sake.
-
Download Hugo v0.53.
-
Clone this repo:
git clone --recurse-submodules git@github.com:eldar/personal-website.git
cd mywebsite- View your website:
hugo serverNow you can go to http://localhost:1313 and your new Academic powered website should appear.
-
Edit bio and publications in
content/ -
Regenerate the websiste by running
hugo- Push to github.io repo:
cd public
git checkout main
git add .
git commit
git push origin main- Commit changes to the website source code:
cd ..
git add public content/*
git commit
git push-
Set your name in
config.tomlin the[params]section. Also set the title of the website -
Add short bio to the
content/home/about.md
- Now you can start adding publications. Publications are stored in the
content/publicationdirectory, you can use mine as an example. In order to generate data for publication you can use a python tool that is supplied with the Academic framework:
# First install the tool:
pip3 install academic
# then import the .bib file into the website
# make sure your current directory is the root of the website repo
academic import --bibtex /path/to/publication.bib- The previous step will create a directory corresponding to the publication under
content/publication. This directory will contain fileindex.mdwhich contains various definitions. You will have to open it and make further edits:
- Set the abstract to the
abstractfield, if not already there - Set unique publication identifier to the
shortname, much like you do in the bibtex, for example"watson2018cvpr" - Specify abbreviation for the conference in
venuefield, for example"CVPR, 2018" - You can place an optional teaser image to the publication directory, its file name has to contain
featuredin it. - Add various URLs associated with the paper:
url_pdfto link to the PDF of the paper (required),url_projectfor the project page,url_videofor the video,url_codefor the code andurl_slidesfor the slides.
Copyright 2018 George Cushen, Eldar Insafutdinov.
Released under the MIT license.