This is the github repo for wmlg.io, the website is directly served from this respository, so changes made here will be reflected on the site. There is a guide below for appending items, please get in contact with Sueda Ciftci if you would like to add a new page or have any questions.
Content on the WMLG page is written using markdown and JSON on top of Jekyll. Markdown is simple to write and avoid the need for content to be written using html.
The editing process is summerised below:
- Navigate to the markdown file you wish to edit.
- Click the edit button (represented by a marker pen).
- Make your changes.
- Once you're done, write a message in the commit changes section at the bottom, then click the commit changes button for the changes to go live. Keep in mind GitHub requests up to 20 minutes processing time.
The following pages can be edited with markdown:
The following pages can be edited with JSON and are all found in /_data/:
- Front page logos
- People records
- News Items
- Research groups
- Teaching classes
The only item which cannot be edited by modifying the Markdown or JSON files are the published papers list, this is to maintain strict formatting and thus converted manually from a BibTex file.
To add a page, there are two options, take an existing bit of HTML and display that alone, or add a markdown file with all the default formatting. To add an existing html file, place it in the top-level directory with the following header yaml:
---
title: Page Title
layout: blank
permalink: /link-on-page/
---
<!-- (html file contents) -->If you're just adding a markdown file, rename with .markdown extension and add the following header yaml:
---
title: Page Title
layout: default
permalink: /link-on-page/
---
<!-- (markdown file contents) -->You can build the site locally with Jekyll:
cd wmlg.io # inside the repo
gem install bundle # bundler to combine asset files
bundle install # bundle will install jekyll + other deps (if there are any)
bundle exec jekyll serve # serve a dev server with live updatesThis markdown cheatsheet is a great overview, and probably tells you everything you need to know.
In addition to normal markdown, please follow the below rules. Not doing so can result in strange behaviour when converting to html.
- Leave a trailing space after the hashtag when writing headers, e.g.
# Leave a space after the hashtag- Leave a blank line before and after vertical lines (e.g. *** or ___)
The website supports basic Latex mathematics. Inline Latex is written inside two
The two Latex packages supported are AMSmath and AMSsymbols. Please get in contact if you require more packages. By default, pages with pre-existing latex have had a the YAML tag markdown: true included. If creating a new page with LaTeX support, please include this tag in the page file (top-level, not a layout) for MathJax JavaScript to be appended.
Images are supported in markdown, but are not always styled properly when there are many images in a document. To add an image, place it within the assets/imgs folder and reference it within your page with either markdown or {{ "/assets/imgs/name.png" | relative_url }} inside html.
A Warwick machine learning group bibtex file is kept up to date. The bibtex file is converted to a json file which is then loaded onto the page using JavaScript. A build script is available to automate this process:
To run the script you will need to install pandoc.
./build.shWhenever you update the bib file, please run this build script to update the webpage.
We want members of WMLG to be able to add news items. This article gives a possible way to use google forms, sheets and scripts.
Converting from markdown to html is done using pandoc.
pandoc --atx-headers source.md -t html -o target.html --mathjax=https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMMLNote that a space is required before every header.