BIASlab website content

This repository contains all the content necessary for proper rendering of BIASlab group website.

Installation

Prerequisites

You need to have Hugo static site generator installed and working. More information might be found at Hugo Installation Guide.

Please install Hugo v0.16 or newer. Otherwise certain sections of the website won't be generated.

Working installation of GNU Make is recommended, but not required. You can test if you have it installed by typing make -v in the terminal.

Getting started

1. Create a directory where you're planning to store the website:

    mkdir biaslab
   

2. Clone this repository and step into the directory:

    git clone [email protected]:biaslab/biaslab-hugo.git ./biaslab
    cd ./biaslab
   

3. Create config.local.toml file by copying the contents of the config.toml file:

    cp config.toml config.local.toml
   

   This will allow you to debug and edit the website without touching the main configuration file, config.toml. If you want to use the make preview-website-local command, don't forget to change the baseurl parameter to http://localhost:8000 in your newly created local config file.

4. Install hugo-academic-group theme:

    make install-theme
   

   If you don't have a working installation of GNU Make, follow the installation instructions from hugo-academic-group repository.

5. To add new content use hugo new command:

    hugo new post/post-title.md
   

   This way hugo will generate a template markdown file based on corresponding archetype with some of attributes filled with default values (creation timestamp, etc.), which you can later edit.

   More information on adding content can be found in the Hugo documentation in Content and Getting Started sections.

6. All the basic build operations might be carried with the use of make command. If you do not have a working installation of GNU Make, study the contents of the Makefile and use the corresponding commands to operate the website. Currently following commands are defined in the file:

   • install-theme: Installs hugo-academic-group theme.
   • update-theme: Updates the theme.
   • build-website: Generates all the static content for the website.
   • preview-website: Builds the website content and starts Hugo debugging server with live reload enabled.
   • publish: Publishes the contents of the ./public directory to the master branch of https://biaslab.github.io repository.

How can I publish my Jupyter notebook on this website?

1. Convert the notebook using juputer-nbconvert command, specifying Markdown as an output format:

    jupyter-nbconvert --to markdown ./notebook.ipynb
   

   This command should convert your notebook to markdown file named notebook.md and create a separate directory for the files required for proper rendering of Markdown file named notebook_files.

2. Move the notebook_files directory somewhere to the static folder of the website (for example, /static/images/notebook_files). Open the notebook.md file and edit all the links to the images accordingly to the place where you've put the folder, omitting /static part of the path. For example:

    ![png](notebook_files/image.png) --> ![png](/images/notebook_files/image.png)
   

3. Create a new post:

    hugo new post/notebook.md
   

   and copy content from your original notebook.md file to the newly created post. This way Hugo will automatically populate some fields in the header of the file.