Contributing and Customizing

Whether you're looking to contribute or just want to customize the theme for yourself, you're in the right place.

Technology Requirements

The following will need to be installed:

Xcode Command-Line Tools (In the Terminal app, run sudo xcode-select --install)
Node.js (check the .nvmrc file for the correct version to use)
Yarn berry (this repository does not commit the cache)

Node Version Manager Users

If you use NVM, simply run nvm install and nvm use at the project root to install and switch to the correct node version.

Visual Studio Code Users

If you use VS Code, this repository provides recommended extensions that compliment the codebase. We highly encourage installing them.

To install dependencies, simply run:

yarn

Theme development:

yarn serve

Runs SassDoc, using this theme, against these sample files:

yarn preview