AsciiDocsy Setup

These topics topic will guide you through the nitty-gritty of setting up AsciiDocsy with Jekyll — either integrating it into your existing Jekyll site or starting from scratch.

If you are already at home with Jekyll and Asciidoctor, try the Quickstart guide or go straight to the Boostrapping guide.

If you are new to Jekyll or Asciidoctor, get familiar with the environment and related tools for this project before installing and building for the first time.

Basic Installation

Use either of Jekyll’s supported methods for adding a gem-based theme to a Jekyll application.

We highly recommend using Bundler and a Gemfile.

  1. Enter AsciiDocsy as a plugin to Jekyll.

    Gemfile entry
    gem 'jekyll', '~> 4.2'
group :jekyll_plugins do
  gem 'asciidocsy'
  gem 'jekyll-algolia', "~> 1.4"
end

  2. Set AsciiDocsy as your theme.

    _config.yml
    theme: asciidocsy
Feedback, please.