Search

Advanced Search

Installation Guide

How to install the Arsxy Jekyll theme

There are two ways to install the Arsxy Theme for your Jekyll site: as a remote theme (recommended) or as a regular gem-based theme.

This method allows you to use the theme directly from GitHub, making it easier to stay updated with the latest version.

1. Add to your _config.yml

Add this line to your Jekyll site’s _config.yml file:

remote_theme: awcodify/arsxy-theme

2. Install Required Plugins

Add these plugins to your Gemfile:

# In your Gemfile
group :jekyll_plugins do
  gem "jekyll-remote-theme"
  gem "jekyll-feed"
  gem "jekyll-seo-tag"
  gem "jekyll-sitemap"
  gem "jekyll-paginate"
end

3. Install the Bundle

Run the following command to install the necessary gems:

bundle install

Installing as a Gem-based Theme

For users who prefer a traditional gem-based approach:

1. Add to your Gemfile

Add this line to your Jekyll site’s Gemfile:

gem "arsxy-theme"

2. Add to your _config.yml

Add this line to your Jekyll site’s _config.yml file:

theme: arsxy-theme

3. Install the Bundle

Run the following command:

bundle install

Verifying the Installation

After installation, start your Jekyll server:

bundle exec jekyll serve

Visit http://localhost:4000 in your browser to verify that the theme is working correctly.

Troubleshooting

If you encounter any issues during installation:

  • Ensure you’re using Jekyll 3.10 or compatible versions
  • Check that all required plugins are installed
  • Make sure your _config.yml is formatted correctly

For more detailed help, see the Troubleshooting section.

Next Steps

Once you have installed the theme, check out the Quick Start Guide to begin configuring and customizing your site.