Tools

This page is about adding/managing the tools section of the website.

Each tool is represented by a markdown file in the tools folder. Each tool has an item on the tools page.

Adding a New Tool

This adds a new tool listing on the tools page, and creates a new page for the tool too.

To add a new tool, first create a new markdown file in the _tools folder.

The markdown file should have the following in its header:

---
layout: tool
title: "tool name"
blurb: "A one or two sentence description of the tool"
author: "the tool's author"
---

The tool layout will add a link back to the tools list at the top of the tool's page. The title will be displayed at the top of the tool's page and in the tool list. The blurb should be a description of the tool, perhaps one or two sentences. This will appear in the tool list only. The author should be the author(s) of the tool. This will be displayed on the tool's page and in the tool list.

Add the text describing the tool to the body of this file, including links to publications or source code repositories, etc. Try looking at an existing file in the _tools folder for an example.

Then push the new file to the master branch. Once the website has recompiled (this might take a minute or two, depending on Github) you should see the listing when you refresh the tools page. Clicking on 'More Details' should take you to the new page for the tool itself.