trallard / modules-template

Jekyll template tailored specifically for use by academics and researchers etc :lollipop:

Modules template

Modules template is a Jekyll template tailored specifically for use by academics and researchers wanting to generate a literate programming friendly and hassle free static website. This can be used as a scientific blog template or as a webpage to host/display projects information, scientific outputs or as a site for academic modules.

It's features include the ability to create blog posts, the ability to create and host Reveal.js presentations. It also enables tight integration with Jupyter notebooks and Microsoft Azure notebooks.

It is also designed to be hosted on GitHub pages. Modules template allows you to create a well designed, functional and completely free website. Hosting on GitHub pages allows you to keep the website in one place, even if you move between institutions.

The live demo of this template can be found at http://bitsandchips.me/Modules-template/ 💻

Why Should I Use This?

By using this template you will have a website that is well designed, easy to maintain, free to host and easy to update. While there are many options out there for personal and professional websites, most are dependant on the platform on which they were built, and cannot be easily migrated. This template, while built for GitHub Pages integration, provides flexibility should you choose to host it elsewhere.

Getting started with Modules template

📃 The complete documentation to get started with Modules template as well as for the advanced features of Modules template can be found at http://bitsandchips.me/Modules-template-docs

Examples of courses using the template can be found on the following links:

• COM3240 Adaptive Intelligence
• BioInformatics Awareness Days

modules-template's Issues

Azure notebook link opens in wrong library

This notebook http://bitsandchips.me/Modules-template/Day1/basic_classification/
The Azure link opens the BAD days Azure library.

Perhaps we could have a separate Azure library just for the demo page of the template? It could include a random selection of notebooks BAD Days, GpY, Something from Julia, etc.

I'll be showing off the template tomorrow in Naples so I'm really grateful for the demo course you've done :)

Search

Add search to the navbar

Add Travis

Need to add CI to the template

Rendering problem with GPy notebook

This is what I see on my Mac, google Chrome

Build CI

publish and test for automatic deploy

404

Add 4040 page to the website

Fix TOC

Working properly unless it is in very small displays

Correct buttons

Make sure they point to the right place in the nb.collection

Return to outline

Double check as some were acting as download instead