Website listing the software and other output used/made/changed in this NLeSC project.
Install requirements with:
pip install -r utils/requirements.txt
python utils/generate.py config <organization name>
This will use the Github API to fetch information about the organization and write the _config.yml file. The _config.yml must be edited to complete the configuration.
python utils/generate.py repos <organization name>
This will generate a Markdown file in _repos directory for each public repo found in the organization.
The list of doi's in _data/dois.yml can be converted to a publication list _includes/publications.html by
python utils/generate.py publications
The default citation style is apa.
Creating news item can be done by creating a Markdown file in the _posts directory.
The files should be called YEAR-MONTH-DAY-title.md and contain the following front matter.
---
title: New version of software X
---
See https://jekyllrb.com/docs/posts/ for more information.
The team members of the project can be displayed on this website.
To add a new member create a biography file in _team_members/ directory where the filename should be the person name.
The following front matter should be used.
---
title: <Name of person>
photo: <Url of photo of person, eg. /assets/team_members/name_of_person.jpg>
role: <Role of person>
---
A photo of the person should be added to the assets/team_members/ directory with the same name as the biography.
docker run --rm --volume=$(pwd):/srv/jekyll -i -t -p 127.0.0.1:4000:4000 jekyll/jekyll:pages jekyll serve
The website can be viewed at http://localhost:4000
This website can be automatically updated see BUILD_NIGHTLY.md and BUILD_ON_CHANGE.md.