Creating a new workshop

Thank you for considering doing a new workshop!

Start by choosing the topic and target audience. Workshops published in this repository must be open source, available online and come with a written or recorded guide.

Consider checking already published workshops. You could contribute to one of them instead of creating a complete new workshop from scratch.

Fork nem2-workshop-template

We suggest forking the nem2-workshop-template. However, it is not necessary to follow the structure proposed as long as the previous requirements are met.

  1. Check your Ruby version meets our requirements.
$> ruby -v  2.3.3
  1. Clone the forked repository.
$> git clone <url>
  1. Install gems.
$> bundle install
  1. Run Jekyll.
$> bundle exec jekyll serve

Find more information about Jekyll on their official website.

Modify _config.yml

title: NEM2 Workshop Title
description: >- # this means to ignore newlines until "baseurl:"
  Start developing a real use case step by step.
baseurl: "/repository-name" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site, e.g.
repository: your-username/repository-name/

Modify README and

Learning objectives: Describe the target and outcomes of the workshop.

Requirements: Remark the pre-requisites that a person who takes the workshop must take into account before starting.

Modules: Summarize the workshop contents.

Add new lessons

  1. Create a new markdown file inside _lessons folder. The lesson file name must start with the following consecutive number.


  1. The markdown file must start with the following header. Remember to update the title and permalink.
layout: post
title:  "Introduction"
permalink: /lessons/introduction/
  1. Check Markdown Cheatsheet to style your text.

Add project and slides

  1. Consider attaching your project code and slides inside project and slides folder.