Skip to content

Latest commit

 

History

History
55 lines (41 loc) · 2.31 KB

README.md

File metadata and controls

55 lines (41 loc) · 2.31 KB
Raw

Build Status

Monica Tutorials

Monica tutorials is the repository of all the tutorials for MONICA artifacts.

Getting Started

The website generated from this repository can be found at https://monica-project.github.io/

Adding New Sections

In order to add a new section on the tutorial, please add your markdown (your_tutorial.md) to contents/_sections folder. The markdown should have following format

---
layout: default
title: <Title of the Tutorial>  <!--- This is required for the page to come in the side pane --->
---
<span style="font-size:2em;">Title of the Tutorial</span>
<!-- Using Span is a hack to avoid the title to come again in TOC.-->
Few words about the tutorial

* TOC (Do not remove. This is required to show Table of contents)
 {:toc}

## First
Contents 
## Second
Contents

Adding Images to the Sections

You can add image to assets/img folder and directly link it in the markdown file.

Previewing the Tutorials Locally

If you would like to run the Tutorial website locally for easy developemt:

  1. Install Ruby (2.6.5, and not the latest)
  2. clone the repository : git clone https://github.com/MONICA-Project/monica-project.github.io
  3. cd to the cloned directory
  4. Run script/bootstrap to install the necessary dependencies.
  5. Run bundle exec jekyll serve to start the preview server
  6. Visit localhost:4000 in your browser to preview the theme

Affiliation

MONICA
This work is supported by the European Commission through the MONICA H2020 PROJECT under grant agreement No 732350.

The code is taken from the minimal theme by orderedlist