Pickles is an open source living documentation generator that works on feature files written in the Gherkin language, popularized in tools like Cucumber and SpecFlow.
| Status | |
|---|---|
| Docs | |
| GitHub Release |  |
| Chocolatey (pickles) |  |
| Chocolatey (picklesui) |  |
| NuGet (Pickles) |  |
| NuGet (Pickles.CommandLine) |  |
| NuGet (Pickles.MSBuild) |  |
Pickles can be incorporated into your build process to produce living documentation in a format that is more accessible to your clients. Gherkin language files are written in plain text and stored in your source folder. This can make them inaccessible to clients who may not know how to work with source control or who are not interested in seeing all of the source code, just the features.
Why stop with just the features though? Pickles can also read plain text files written in the Markdown format so you can add other files to your feature to add all sorts of context. Well-written features are great to have but even the best written features can leave out some important context information. Markdown is very simple to write and is designed to be easily read even in plain text files so they are a great way of adding additional context to your feature files to turn them into a real set of living documentation.
- HTML
- DHTML (javascript-enabled, search capabilities)
- JSON
- Word
- Excel
If there are other formats you would like to see feel free to create a GitHub Issue.
- NUnit (versions 2.x and 3.x)
- xUnit (versions 1.x and 2.x)
- MSTest
- Cucumber JSON
- SpecFlow+ Runner (formerly known as SpecRun)
It's easy to contribute to Pickles, just setup an account on github and fork the project. When you have some code to contribute, send a pull request! There are plenty of ideas for contributions on the wiki and in the issues list.
Pickles is licensed with the Apache License, version 2.0. You can find more information on the license here: http://www.apache.org/licenses/LICENSE-2.0.html