Avalanche is a highly configurable research portfolio website template based Jekyll and bulma.
-
Install Jekyll via their official instructions.
-
Download this repository, install dependencies, and start the server
git clone https://github.com/lolipopshock/avalanche.git && cd avalanche bundle install bundle exec jekyll serve
- Please check the tutorial.
Besides website titles and URLs, we provide a list of configurations for customizing your website in the _data folder. This includes:
-
Regular website settings
_config.yml:title: Your Name description: > The portfolio website for you. baseurl: "" url: ""
-
Configure texts on the index page
_data/meta.yml:index: welcome_message: personal_photo: news_highlight_color: personal_description:
-
And update the news using
_data/news.csvfile. -
Add your social media accounts by editing
socialin_data*/settings.yml: -
Change tabs on your website
_data/settings.yml:menu: - {name: 'About', file: ''} - {name: 'Research', file: 'research.html'} - {name: 'Blog', file: 'blog.html'}
-
Customize the publication page (see in the next section):
Believing your publication page is not simply a repetition of your google scholar page, we design the publication page that helps you organize your work and present them to the audience in a clean and intuitive fashion.
The publication page is rendered based on the _data/settings.csv table. Explanation for the features in the table:
type: The type of the publication, e.g., workshop paper, conference paper, journal paper. Defined in the_data/meta.ymlfile.topic: The shorthand for the topic of the publication. Topics are defined in the_data/settings.ymlfile.name: A shorthand name for the paper.author: Authors of the paper. You could use markdown grammar like**to bold your names.title: The title of the paper.venue,publisher: The venue of a conference paper, or the publisher of a journal paper.paper,website,arxiv,poster,video: The links to the paper's pdf, project website, arxiv page, poster, or video.img: An overview image for the paper. You could use the/assets/publications/placeholder.pngif you don't have the images.
We provide a tab in the research page, which helps you group your publications by specific categories. By doing so, you need to:
- Set the categories' display names
nameand shorthand namesidin the_data/settings.ymlfile. For example:publication: topics: - {name: 'All', id: 'all', description: ''} # it will automatically handle the `all` category - {name: 'Deep Learning', id: 'dl', description: ''} - {name: 'GAN', id: 'gan', description: ''} - {name: 'Other', id: 'misc', description: ''}
- For each paper, set their category in the
topicfeature using the correspondingidfor the category.
You can also consider group papers based on their types.