https://github.com/getgauge/spectacle
Generates HTML from Markdown
https://github.com/getgauge/spectacle
gauge gauge-plugin
Last synced: 8 months ago
JSON representation
Generates HTML from Markdown
- Host: GitHub
- URL: https://github.com/getgauge/spectacle
- Owner: getgauge
- License: apache-2.0
- Created: 2016-05-10T13:31:12.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-05-12T07:11:12.000Z (8 months ago)
- Last Synced: 2025-05-12T08:37:22.277Z (8 months ago)
- Topics: gauge, gauge-plugin
- Language: Java
- Homepage:
- Size: 534 KB
- Stars: 18
- Watchers: 10
- Forks: 6
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Spectacle
=========
[  ](https://bintray.com/gauge/spectacle/Nightly/_latestVersion)
[](https://travis-ci.org/getgauge/spectacle)
[](CODE_OF_CONDUCT.md)
Generates HTML from Specification/Markdown files. This is a plugin for [gauge](https://gauge.org).
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](https://github.com/getgauge/spectacle/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
* [Golang](http://golang.org/)
#### 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
```
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``).
License
-------
`Spectacle` is released under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full license text.