Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
The open source living documentation generator
C# JavaScript HTML Cucumber CSS PowerShell Other

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
src/Pickles
tools
.gitignore
LICENSE
NOTICE
README.md
build-release.cmd
project.build

README.md

Introduction

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 documenation 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.

Pickles primarily produces static HTML files. The reason for this is that static HTML can be deployed to any old web server, you don't need any special libraries, databases or other tools that might limit your installation possiblities. If you are behind a corporate firewall with no internet access then you will appreciate this option! We plan to support other documentation formats in the future. Office Open XML (.docx), PDF and JSON formats are on the wishlist. If there are other formats you would like to see then why don't you post on the newsgroup we have for pickles development

Contributing

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.

License

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

Something went wrong with that request. Please try again.