The Testspace Spec model is compatible with the GitHub Jekyll model, where a separate parsing and static HTML generation step occurs. As a result of this approach, it is easy to leverage Jekyll for local Spec development and previewing.
Use Jekyll on your desktop for local
test spec development and previewing.
To leverage Jekyll on the desktop, a few one-time steps are required.
For more details on installing Jekyll refer here.
The first step is to install the Jekyll gem:
It is recommended to set up Jekyll in the same folder as your test specs (i.e.
cd specs). There are
5 files required to be added to your repo under the
- Jekyll requires a configuration file:
- The following
Gemfilefile is required:
- A simple index markdown file is required:
.gitignorefile should be added, ignoring the local Jekyll generated file:
- Note that the
Gemfile.lockwill be automatically generated on the following install step.
Once the files have been added, or if the repo has been cloned/forked, it is required run the bundler to install dependencies based on the Gemfile:
To Run Jekyll use the following:
For a Spec to be listed using Jekyll, the following additions are required.
Add the following variable:
spec object requires assignment to the
page object. Add this 1-line statement after the front matter header block:
The following is a template example: