-
Notifications
You must be signed in to change notification settings - Fork 5
/
index.html
199 lines (171 loc) · 10.5 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
<!DOCTYPE html>
<html>
<head>
<title>Pickles - the open source Living Documentation Generator</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="fragment" content="!">
<!--<link rel="shortcut icon" type="image/x-icon" href="favicon.png"/>-->
<meta charset="UTF-8">
<meta name="author" content="Dirk Rombauts">
<link rel="stylesheet" href="./Content/bootswatch.flatly.min.css"/>
<link rel="stylesheet" href="./Content/custom.css" />
</head>
<body>
<nav class="navbar navbar-default navbar-static-top">
<div class="container-fluid">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="#">Pickles</a>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav">
<li><a href="http://docs.picklesdoc.com/en/latest/">Docs</a></li>
<li><a href="https://github.com/picklesdoc/pickles">View on GitHub</a></li>
</ul>
</div><!-- /.navbar-collapse -->
</div><!-- /.container-fluid -->
</nav>
<div class="container">
<div class="page-header">
<h1>
<img src="./Images/pickles.png" width="621" alt="Pickles" />
</h1>
</div>
<div class="row">
<div class="col-sm-3">
<!--
<div class="panel panel-default" style="padding: 1em;">
<a href="https://picklespro.typeform.com/to/SCPy7i">Please help us determine our next efforts by answering this short survey.</a>
</div>
-->
<div class="panel panel-default">
<ul class="list-group">
<li class="list-group-item"><a href="#what_does_pickles_do">What does Pickles do?</a></li>
<li class="list-group-item"><a href="#example_output">Example Output</a></li>
<li class="list-group-item"><a href="#download">Download</a></li>
<!--<li class="list-group-item"><a href="#we_need_your_help">We need your help!</a></li>-->
<li class="list-group-item"><a href="#release_notes">Release Notes</a></li>
<li class="list-group-item"><a href="#source_code">Source Code</a></li>
<li class="list-group-item"><a href="#previous_versions">Previous Versions</a></li>
<li class="list-group-item"><a href="#copyright_and_licences">Copyright and Licenses</a></li>
</ul>
</div>
</div>
<div class="col-sm-9">
<h2 id="what_does_pickles_do">What does Pickles do?</h2>
<p>Pickles is a Living Documentation generator: it takes your Specification (written in Gherkin, with Markdown descriptions) and turns them into an always up-to-date documentation of the current state of your software - in a variety of formats.</p>
<!-- Carousel Begin -->
<div id="carousel-example-generic" class="carousel slide" data-ride="carousel">
<!-- Indicators -->
<ol class="carousel-indicators">
<li data-target="#carousel-example-generic" data-slide-to="0" class="active"></li>
<li data-target="#carousel-example-generic" data-slide-to="1"></li>
<li data-target="#carousel-example-generic" data-slide-to="2"></li>
<li data-target="#carousel-example-generic" data-slide-to="3"></li>
<li data-target="#carousel-example-generic" data-slide-to="4"></li>
</ol>
<!-- Wrapper for slides -->
<div class="carousel-inner" role="listbox">
<div class="item active">
<img src="./Images/BasicGherkin.png" alt="A feature in Gherkin format">
<div class="carousel-caption">
A feature in Gherkin format in Visual Studio
</div>
</div>
<div class="item">
<img src="./Images/DynamicHtml.png" alt="The feature in the Dynamic HTML format">
<div class="carousel-caption">
The feature in the Dynamic HTML format
</div>
</div>
<div class="item">
<img src="./Images/StaticHtml.png" alt="The feature in the Static HTML format">
<div class="carousel-caption">
The feature in the Static HTML format
</div>
</div>
<div class="item">
<img src="./Images/Word.png" alt="The feature in Word format">
<div class="carousel-caption">
The feature in Word format
</div>
</div>
<div class="item">
<img src="./Images/Excel.png" alt="The feature in Excel format">
<div class="carousel-caption">
The feature in Excel format
</div>
</div>
</div>
<!-- Controls -->
<a class="left carousel-control" href="#carousel-example-generic" role="button" data-slide="prev">
<span class="glyphicon glyphicon-chevron-left" aria-hidden="true"></span>
<span class="sr-only">Previous</span>
</a>
<a class="right carousel-control" href="#carousel-example-generic" role="button" data-slide="next">
<span class="glyphicon glyphicon-chevron-right" aria-hidden="true"></span>
<span class="sr-only">Next</span>
</a>
</div>
<!-- Carousel End -->
<p style="margin-top: 1em;">Additionally, you can provide Pickles with the results of your Executable Specification. Pickles will show a pass/fail mark next to each scenario.</p>
<p class="lead">Read more about the what and why of Pickles in our <a href="http://docs.picklesdoc.com/">documentation</a>, or have a look at the example output in the next section.</p>
<h2 id="example_output">Example Output</h2>
<p>Pickles can generate your documentation in the following formats:</p>
<ul>
<li><a href="./pickles/Output/Dhtml/Index.html">HTML site with search capabilities</a></li>
<li><a href="./pickles/Output/Html/index.html">Static HTML site</a></li>
<li><a href="./pickles/Output/JSON/pickledFeatures.json">JSON raw datas</a></li>
<li><a href="./pickles/Output/Word/Pickles.docx">Word (.docx)</a></li>
<li><a href="./pickles/Output/Excel/features.xlsx">Excel</a></li>
</ul>
<h2 id="download">Download</h2>
<p>Version 2 needs .NET 4.5 - this may be a breaking change for some, but the download sizes are much smaller now. Pickles should run faster too.</p>
<p>Each runner has a link when you can find download information:</p>
<ul>
<li><a href="https://chocolatey.org/packages/pickles">Command Line</a></li>
<li><a href="https://chocolatey.org/packages/picklesui">GUI</a></li>
<li><a href="http://www.nuget.org/packages/Pickles/">PowerShell</a></li>
<li><a href="http://www.nuget.org/packages/Pickles.MSBuild/">MSBuild</a></li>
</ul>
<p>
If you prefer to download the .zip files, you can so from the <a href="https://github.com/picklesdoc/pickles/releases">Github release page</a>.
</p>
<h2 id="release_notes">Release Notes</h2>
<p>
Check out the <a href="https://github.com/picklesdoc/pickles/releases">release notes</a> to see what's new.
</p>
<h2 id="source_code">Source Code</h2>
<a href="https://ci.appveyor.com/project/dirkrombauts/pickles-715"><img class="img-responsive img-thumbnail" src="https://ci.appveyor.com/api/projects/status/rqt59hq1m2jt2a5v" alt="Build status"></a>
<ul>
<li><a href="https://github.com/picklesdoc/pickles/zipball/develop">Download ZIP File</a></li>
<li><a href="https://github.com/picklesdoc/pickles/tarball/develop">Download TAR Ball</a></li>
</ul>
<h2 id="previous_versions">Previous Versions</h2>
<p>
You can find previous versions of Pickles on the <a href="https://github.com/picklesdoc/pickles/releases">Release page on GitHub</a>.
</p>
<h2 id="copyright_and_licences">Copyright and Licenses</h2>
<p>Pickles is copyrighted:</p>
<ul>
<li>Jeffrey Cameron 2011-2012</li>
<li>PicklesDoc and community contributors 2012-present</li>
</ul>
<p>
Pickles is licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
</p>
<p>Pickles uses several open source libraries that are governed by their own licenses.</p>
</div>
</div>
</div>
<script src="./Scripts/jquery-2.1.4.min.js"></script>
<script src="./Scripts/bootstrap.min.js"></script>
</body>
</html>