Skip to content

Latest commit

 

History

History
30 lines (23 loc) · 1.23 KB

README.md

File metadata and controls

30 lines (23 loc) · 1.23 KB

tskit.dev

This repo is the source code for http://tskit.dev

The site is made with jekyll and built with grunt.

Dependencies

gem install --user-install bundler jekyll
bundle install 

Building the site

To build the site you will need a github auth token (for API requests, no permissions are needed on the token) GITHUB_TOKEN=YOUR_TOKEN_HERE grunt dev

Data sources

News, software and resources are the jekyll collections driving the site. The front matter of each file in their respective directories provides the metadata for each entry, which is supplemented with information from API requests by plugins. Any information in front matter overrides that from API requests - useful for fixing bad publication info for instance. To not hit rate limiters API requests are cached, to clear the cache rm /tmp/open-uri-*.

To add a new item create an additional file in either the _software, _news or _resources directory. Refer to the existing files for the required YAML keys in the front matter. Any images needed should be places in the assets/images folder and referred to with this template: {{ '/assets/images/PATH/TO/file.svg' | relative_url}} this will cause the file to be added to the build.