---

layout: default

title: "Together"

A Jekyll theme.

Quick Start

This theme is, itself, a Jekyll blog, meaning the code base you see has everything you need to run a Jekyll powered blog!

To get started quickly, follow the instructions below:

1. Click the Fork button at the top of the repository;
2. Go to your forked repo's Settings screen;
3. Scroll down to the GitHub Pages section;
4. Under Source, select the Master branch;
5. Hit Save.
6. Follow Jekyll's instructions to configure your new Jekyll site.

Manual Installation

If you've already created your Jekyll site or are comfortable with the command line, you can follow Jekyll's Quickstart instructions add this line to your Jekyll site's Gemfile:

gem "together-theme"

And add the following lines to your Jekyll site's _config.yml:

theme: together-theme

The Together Theme's configuration has sensible defaults, but you may wish to ignore the default configuration and supply your own:

ignore_theme_config: true

And then on the command line, execute:

$ bundle

Or install the theme yourself as:

$ gem install together-theme

Usage

And you'll need to install the JS modules:

$ yarn || npm i

Start it up with

bundle exec jekyll serve

Progress bars

To disable the progress bars (for each H2, H3), add a progress: false attribute to the page in question. You can also add set it in your config.yml file:

together:
  progress: false