Website for the MARuSS project

This is the website for the EPSRC-funded project: Musical Audio Repurposing using Source Separation (MARuSS)
This repository might be useful for setting up a simple website suited for the academic blogger
We are using the simple Minima Jekyll theme with some personalised styling
References are handled by the excellent Jekyll-Scholar

Setting up your own site

Jekyll Requirements

Install install Ruby. It is recommended that you install Ruby with rbenv, see here for example.
Install Bundler:
```
gem install bundler
```

GitHub Pages

Clone this repository
Move inside and run:
```
bundle install
```

Connect your remote repository on GitHub:

git remote set-url origin https://github.com/username-or-organization-name/your-remote-repository-name

In _config.yml:
- Set baseurl to /your-repository-name
- Set url to https://your-username.github.io

Configuration and structure

After reading this, check and modify the values in _config.yml (it is documented)
One-off pages should live in the root directory and use front matter along the lines of:
```
---
layout: page
permalink: /publications/
title: Publications
menu_order: 1
---

## My Content
```
where menu_order specifies the order in which a page will be displayed in the header. Omit this key if you do not wish for a page to appear in the menu.
Put your bibtex file in the ./_bibliography directory. If it's not called references.bib, update the value of scholar > bibliography in ./_config.yml accordingly.
If you don't want to use the default IEEE citation style, add your desired cls file in the _./bibliography directory and update the value of scholar > style in ./_config.yml. Note that provided cls files have been modified so that the citation number does not appear in the publication list (see this for more info). Therefore, don't use these files for anything else...
The entire bibliography of ./bibliography/references.bib is generated, via Jekyll-Scholar, on the publications page. You can limit the selection to those entries with the (single) keyword given by the option query_by_this_bibtex_keyword in ./_config.yml. This is useful for listing those publications belonging to the author(s) of the website (by default it is maruss).
If you want PDFs to be downloadable via a link attached to each reference, dump them in assets/pdfs. The only convention is that the filename of the PDF associated with a given bibtex entry should match its key, e.g.
```
@article{bob_1933} -> bob_1933.pdf
```
Using your bibtex file, Jekyll-Scholar will automatically generate a details page for each publication listed on the publications page. This page will appear at site_url/publications/bibtex_key.html. Details include an abstract, the bibtex entry and the DOI. If you want to append additional information to the details page (such as code, references, discussion points etc.), create a markdown file in the directory _publication_details whose filename matches the key of the bibtex entry. For example, if _bibliography/references.bib contains:
```
@article{bob_1933,
title = {bob},
author = {bob},
year = {1933}
}
```
and then _publication_details/bob_1933.md might give some additional information on the details page (only empty front matter is needed for this):
```
---
---
## Aditional information

All information here will be appended to the details page which will show up at
site_url/publications/bob_1933.html
```
Posts should live in the _posts directory, following the filename convention YYYY-MM-DD-name-of-posts.md. Front matter should be along the lines of:
```
---
layout: post
title: My Post
categories: audio
---
```
As with publications, the latest 3 posts will be listed on the home page.
You can change the colours by giving assets/main.scss a quick skim and then tweaking

Building

To build your site locally:
```
bundle exec jekyll serve
```
and then visit the printed server address, e.g. http://127.0.0.1:4000/your-repository-name/

To publish your site on GitHub pages:

bundle exec jekyll build
git commit -a -m "New build"
git subtree push --prefix _site origin gh-pages

or just execute the script _scripts/build_and_deploy_site.sh

CVSSP/maruss-website

Website for the MARuSS project

Setting up your own site

Jekyll Requirements

GitHub Pages

Configuration and structure

Building