Sandbox Jekyll documentation

Getting Started

Complete guide to installing and setting up the Sandbox Jekyll theme

Getting Started with Sandbox Theme

Prerequisites

Before installing the theme, ensure you have the following installed:

  • Ruby (version 2.7.0 or higher)
  • RubyGems
  • GCC and Make

Installing Jekyll

Run the following command to install Jekyll and Bundler:

gem install jekyll bundler

Verify Installation

After installation, verify Jekyll is installed correctly:

jekyll -v

Theme Installation

Download and extract the theme:

Unzip the downloaded file
cd sandbox-jekyll-theme

Install Dependencies

Run the following command to install project dependencies:

bundle install

Start Development Server

Use the following command to start the local development server:

bundle exec rake serve

Access Local Site

Your site should now be running at:

http://localhost:4000

Project Structure

The project directory is structured as follows:

sandbox-jekyll-theme/
├── _data/          # Site configuration files
├── _includes/      # Reusable components
├── _layouts/       # Page layouts
├── _posts/         # Blog posts
├── _sass/          # Sass partials
├── assets/         # Static files
└── _config.yml     # Main configuration

Configuration

Modify the _config.yml file to configure your site settings:

# Site Settings
title: Your Site Title
email: your.email@example.com
description: >-
  Your site description
baseurl: ""
url: ""

# Build settings
markdown: kramdown
permalink: /blog/:title/

# Collections
collections:
  projects:
    output: true
    permalink: /projects/:path/
  authors:
    output: true
    permalink: /authors/:path/