Lab Website Template

An easy-to-use, flexible website template for labs, including automatic citations, GitHub tag imports, pre-built components, and more. Spend less time reinventing the wheel and more time running your lab.

Still in pre-release/preview. We need testers!

Please help us out! How easy is the template to use? How flexible is it? How's our documentation?

Features

• Automatically generated citations (using Manubot) from just an identifier (DOI, PubMed ID, and many more)
• Automatically pull in and display tags from GitHub repositories
• Works and looks good on all major desktop and mobile browsers
• A suite of pre-built components:
  • formatted tables and code blocks
  • social media links with icons
  • figures with captions
  • image galleries
  • multi-size cards with image and text
  • citations
  • ...and many more!
• A home page, where you can highlight the most important things that make your lab special
• A research page, with a sorted, searchable list of all your published works
• A tools page, where you can show off your software, datasets, or other useful things
• A team page, compiled automatically from individual members
• Individual team member pages with bios, assignable roles, and social media links
• A blog page, with a sorted, grouped, tagged list of all your posts

Gallery

See who else is using the template and what it can do!

Documentation

Get Started

Basic Formatting

Basic Editing

Citations

Advanced Editing

Components

Background Knowledge

Tips

Support

Run Locally

Source: click here.

Build site locally

Normally your site is built automatically on GitHub if you're using one of the standard workflows. But if you want to preview changes to your site before pushing them to your GitHub repo for all to see, you can follow these steps to build and run the site on your computer. Most people wont need or want to do this.

1. Install Ruby v3+ (on Windows, use the installer and the recommended version with the Devkit).
2. Install Bundler by running `gem install bundler.
3. [Install Jekyll] by running gem install jekyll.
4. Go to the folder where you cloned your site, e.g. cd your-lab-website.
5. Bundle the site by running bundle.
6. Start the site by running bundle exec jekyll serve --open-url --livereload --trace.

If you're on Windows and getting errors, see this thread.

The site should automatically open in a browser. Any changes you make should automatically rebuild the site and refresh the page, except for changes to _config.yaml which require re-running the start command.

Build citations locally

Normally your citations are built automatically on GitHub if you're using one of the standard workflows. But if you want to preview changes to your citations before pushing them to your GitHub repo for all to see, or GitHub is having problems generating the citations, you can follow these steps to run the automatic citation process on your computer. Most people wont need or want to do this.

1. Install Python (with PIP).
2. Go to the folder where you cloned your site, e.g. cd your-lab-website.
3. Install needed Python packages by running python -m pip install --upgrade --requirement ./auto-cite/requirements.txt.
4. Add or change the desired sources/papers in /_data/sources.yaml.
5. Generate citations by running python `./auto-cite/auto-cite.pyRi.

Citations should be automatically generated and output to /_data/citations.yaml.