Generates HTML from Markdown
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build Renaming m2h to spectacle Jun 30, 2016
constant Updating spec file separator and css #10 Sep 13, 2017
conv adding utf-8 charset meta tag. Jun 25, 2018
gauge-proto @ dc39364 Updating gauge-proto submodule Apr 5, 2017
gauge_messages
images
json Fixing breaking changes after migrating to proto V3. Jan 14, 2017
processor
util Replicating specs folder structure while converting to HTML Oct 28, 2016
.gitignore
.gitmodules
.travis.yml
README.md
genproto.sh
plugin.json
spectacle.go

README.md

Spectacle

Download Nightly Build Status

Generates HTML from Specification/Markdown files. This is a plugin for gauge.

Spectacle

Installation

gauge install spectacle

To install a specific version of spectacle plugin use the --version flag.

gauge install spectacle --version $VERSION

Offline Installation

Download the plugin zip from the Github Releases.

use the --file or -f flag to install the plugin from zip file.

gauge install spectacle --file ZIP_FILE_PATH

Build from Source

Requirements

Compiling

go run build/make.go

For cross-platform compilation

go run build/make.go --all-platforms

Installing

After compilation

go run build/make.go --install

Creating distributable

Note: Run after compiling

go run build/make.go --distro

For distributable across platforms: Windows and Linux for both x86 and x86_64

go run build/make.go --distro --all-platforms

Usage

Export to HTML

Run the following command to export to HTML in a Gauge project

gauge docs spectacle <path to specs dir>

The html docs are generated in docs directory inside the project.

Filter Specification/Scenario based on Tags

Tags allow you to filter the specs and scenarios. Add the tags to the textbox in the report to view all the specs and scenarios which are labeled with certain tags. Tag expressions with operators |, &, ! are supported.

In the following image, the specs/scenarios are filtered using a tag expression(\ refactoring & !api).

filter

License

GNU Public License version 3.0 Spectacle is released under GNU Public License version 3.0