Getting Started

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:

View example's code

jekyll -v

Theme Installation

Download and extract the theme:

View example's code

Unzip the downloaded file
cd sandbox-jekyll-theme

Install Dependencies

Run the following command to install project dependencies:

View example's code

bundle install

Start Development Server

Use the following command to start the local development server:

View example's code

bundle exec rake serve

Access Local Site

Your site should now be running at:

View example's code

http://localhost:4000

Project Structure

The project directory is structured as follows:

View example's code

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:

View example's code

# Site Settings
title: Your Site Title
email: [email protected]
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/

Project Pages

Single Projects

Usage

Styleguide

Elements

Getting Started

Getting Started with Sandbox Theme

Prerequisites

Installing Jekyll

Verify Installation

Theme Installation

Install Dependencies

Start Development Server

Access Local Site

Project Structure

Configuration