Pickles
**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*. *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. *Pickles* can produce output in different formats: - Static HTML: a set of HTML files with minimal JavaScript - Dynamic HTML: a JavaScript-rich single page app with integrated search - Word: Microsoft Word - Excel: Microsoft Excel - JSON: a custom JSON format - Markdown: a simple output format Optionally, *Pickles* can **integrate test results**, so that your stakeholders know which scenarios pass validation. *Pickles* supports these test formats: - NUnit - MSTest - XUnit - SpecRun - Cucumber JSON
Install
dotnet add package Pickles --version 3.0.0-alpha
Install-Package Pickles -Version 3.0.0-alpha
<PackageReference Include="Pickles" Version="3.0.0-alpha" />
Frameworks
Dependencies
Adoption guide
Assess this package against its supported frameworks, license, maintenance signals and dependency graph before making it a project standard.
This version is marked prerelease. Validate its API and upgrade path before production use.
Compatibility metadata lists 1 target framework; confirm the exact target used by your application.
How to read this guidance
Sources: published NuGet v3 registry metadata and explicit NuBrowse editorial guides. Refresh: package metadata is refreshed from NuGet when the page loads. Limit: this is not a security, legal or compatibility guarantee; validate the selected version in your project.
Useful next steps
Move from package metadata to a concrete selection or review workflow.