This repository contains the source material for the GIX Labs site hosted at gixlabs.github.io. The site is a jekyll site using [just-the-docs]() layout and hosted with [GitHub Pages]()
To contribute to the site, first reach out to Kevin or Andreas to get added to the GIXLabs github organization. You can edit files directly on github. However, it will take about 2 minutes for the changes to show up, so it can be quite time consuming to iterate on changes. It's instead recommended to pull the repository down to your computer and run the site on your local computer, then commit and push your changes when you have it the way you want.
To run the site locally, you'll need to install the prerequisites for Jekyll.
They have a great guide on their website.
Once you have Ruby, RubyGems, GCC and Make installed, run gem install jekyll bundler.
Once the prerequisites are installed:
bundle installjekyll serve --config _config_local.yml http://localhost:4000/You can then make changes to the files in your favorite IDE. It should regenerate the site on each save. Simply you can refresh the page to see your changes.
The root of this directory includes index.md which is the main page of the site.
about.md contains information of people working in the labs.
The tools directory contains all the sites for each tool separated into categories. Each category has an index.md landing page and then one page for each tool of that type.
All images and SOPs are stored in the assets folder, which should have a logical structure for file locations based on site navigation. Note: moving images will break links to them, so be aware of where files are linked before moving anything.
Each page generated with Jekyll starts with front matter. This is the metadata written in YAML at the top of the page that tells the site generator where the title, which layout to use, and where that page falls in the navigation tree.
See just-the-docs documentation on navigation structure to understand what goes in each page's front matter.