Builds static HTML documentation from Gherkin feature files and Cucumber Steps files (any language)
Last updated 3 years ago by immoweb .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @immoweb/gherkindoc 
SYNC missed versions from official npm registry.

GherkinDoc with Step Detection

A processor that transforms Cucumber (Gherkin) feature files into static HTML documentation site. Indicates which steps have an implementation and links them to their github or bitbucket repository. Additionally creates two new tags: 'Implemented' and 'Not Implemented' to list the steps that are complete.

This project is a fork from the GherkinDoc project, started by @alexandrosd. It contains additional code developed by @alexkrechik on the VSCucumberAutoComplete project.


var gherkindoc = require('gherkindoc');
gherkindoc.generate(featuresDirectory, outputDirectory [, options]);

This version doesn't copy the entire featuresDirectory over to outputDirectory. Instead, creates only .html files in the outputDirectory.

The following options are available (defaults are shown):

    theme: 'cosmo', // The [bootswatch](http://bootswatch.com/) theme to use
    renderScenaria: true // whether to render scenario bodies or only feature descriptions,
    steps: [] // A list of paths where the steps are stored

If the parameter steps is not given, then all the steps and features will be marked as not implemented.

Original Author: Alexandros Dallas dallas.alexandros@gmail.com

Fork Author: Josep Mateu Clemente jmateu.clemente@gmail.com

Current Tags

  • 0.6.0                                ...           latest (3 years ago)

1 Versions

  • 0.6.0                                ...           3 years ago
Maintainers (2)
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 1
Dependencies (10)
Dev Dependencies (6)
Dependents (0)

Copyright 2014 - 2016 © taobao.org |