Sha256: 1a0b192caec33a77070fb223a297d5d96fad5b714f2f95821e489c4c00dc8678

Contents?: true

Size: 1.11 KB

Versions: 5

Compression:

Stored size: 1.11 KB

Contents

:page-permalink: /docs/theme/setup
:page-togglers: user-os
= 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.

[.case]*_If you are already at home with Jekyll and Asciidoctor_*, try the <</docs/theme/setup/quickstart#,Quickstart guide>> or go straight to the <</docs/theme/setup/bootstrap#,Boostrapping guide>>.

[.case]*_If you are new to Jekyll or Asciidoctor_*, get familiar with the <</docs/theme/setup/environment#,environment and related tools for this project>> before <</docs/theme/setup/quickstart#,installing and building>> for the first time.

== Basic Installation

Use either of link:https://jekyllrb.com/docs/themes/#installing-a-theme[Jekyll's supported methods] for adding a gem-based theme to a Jekyll application.

We highly recommend using Bundler and a Gemfile.

. Enter AsciiDocsy as a plugin to Jekyll.
+
[source,ruby]
.Gemfile entry
----
include::Gemfile[tags=jekyll-plugins]
----

. Set AsciiDocsy as your theme.
+
[source,yaml]
._config.yml
----
theme: asciidocsy
----

Version data entries

5 entries across 5 versions & 1 rubygems

Version Path
asciidocsy-0.3.0 _docs/topics/setup.adoc
asciidocsy-0.3.0.pre.rc4 _docs/topics/setup.adoc
asciidocsy-0.3.0.pre.rc3 _docs/topics/setup.adoc
asciidocsy-0.3.0.pre.rc2 _docs/topics/setup.adoc
asciidocsy-0.3.0.pre.rc1 _docs/topics/setup.adoc