First and foremost, Welcome!
This document (the README
file) is a hub to give you some information about the
project. Jump straight to one of the sections below, or just scroll down to find
out more.
You need a ruby
environment (version >= 2.4). Either you have it installed and
you know how to install Bundler and
Jekyll and then run Jekyll, or you use
(mini-)conda, a package management system
that can install all these tools for you. You can install it by following the
instructions on this page: https://conda.io/docs/user-guide/install/index.html
In the sequel, we assume you use miniconda.
-
Open a terminal
-
Clone this GitHub repository:
$ git clone https://github.com/
-
Navigate to the
/
folder withcd
-
Set up the conda environment:
$ make create-env
-
Install the project's dependencies:
$ make install
-
Start the website:
$ make serve
-
Open the website in your favorite browser at: http://127.0.0.1:4000/
To avoid dead or wrong links, run the link checkers:
$ make check-html
To create a new blog post:
-
Create a file in the folder
_posts
with a file named following the patternyyyy-mm-dd-name.md
-
Add some metadata on the top of the file
--- layout: post title: <title of the post> author: <github id of the author> image: images/yyyy-mm-dd-name.jpg ---
-
Add content of the post in the file in Markdown
-
Add images in
images/posts/
To create a new blog post:
-
Create a file in the folder
_events
with a file named following the patternyyyy-mm-name.md
-
Add some metadata on the top of the file
--- layout: event title: <title of the event> starts: <start date for the event in format yyyy-mm-dd> ends: <end date for the event in format yyyy-mm-dd> organisers: - <github id of the organisers> trainers: - <github id of the trainers> location: <location> ---
-
Add content of the post in the file in Markdown
-
Add images in
images/events/
Add someone to the list of people:
- Open the
_data/people.yaml
file - Create a new entry there (using the GitHub id, or firstname-lastname if no GitHub id) following the alphabetical order
- Fill in information using the tags:
first-name
last-name
twitter
website
orcid
affiliation
city
country
pronouns
roles
(leader or trainer)