-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.html
executable file
·512 lines (487 loc) · 26 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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Augurk is living documentation on your own terms. Visualize your Gherkin feature files from specification by example workshops and make them easily accessible to everyone in your organization.">
<meta name="author" content="">
<title>Augurk, living documentation on your own terms</title>
<!-- Bootstrap Core CSS -->
<link href="vendor/bootstrap/css/bootstrap.min.css" rel="stylesheet">
<!-- Theme CSS -->
<link href="css/freelancer.min.css" rel="stylesheet">
<!-- Custom Fonts -->
<link href="vendor/font-awesome/css/font-awesome.min.css" rel="stylesheet" type="text/css">
<link href="https://fonts.googleapis.com/css?family=Montserrat:400,700" rel="stylesheet" type="text/css">
<link href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic" rel="stylesheet" type="text/css">
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="icon" href="img/icon16.png">
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-87987412-1', 'auto');
ga('send', 'pageview');
</script>
</head>
<body id="page-top" class="index">
<!-- Navigation -->
<nav id="mainNav" class="navbar navbar-default navbar-fixed-top navbar-custom">
<div class="container">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header page-scroll">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span> Menu <i class="fa fa-bars"></i>
</button>
<a class="navbar-brand" href="#page-top">Augurk</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 navbar-right">
<li class="hidden">
<a href="#page-top"></a>
</li>
<li class="page-scroll">
<a href="#about">About</a>
</li>
<li class="page-scroll">
<a href="#portfolio">Features</a>
</li>
<li class="page-scroll">
<a href="#inspiration">Inspiration</a>
</li>
</ul>
</div>
<!-- /.navbar-collapse -->
</div>
<!-- /.container-fluid -->
<a href="https://github.com/augurk/augurk">
<img
style="position: absolute; top: 0; left: 0; border: 0;"
src="https://camo.githubusercontent.com/121cd7cbdc3e4855075ea8b558508b91ac463ac2/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f6c6566745f677265656e5f3030373230302e706e67"
alt="Fork me on GitHub"
data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_left_green_007200.png">
</a>
</nav>
<!-- Header -->
<header>
<div class="container">
<div class="row">
<div class="col-lg-12">
<img class="img-responsive" src="img/icon256.png" alt="Augurk, living documentation on your own terms">
<div class="intro-text">
<h1 class="name">Augurk</h1>
<hr class="star-light">
<span class="skills">living documentation on your own terms</span>
</div>
</div>
</div>
</div>
</header>
<!-- About Section -->
<section id="about">
<div class="container">
<div class="row">
<div class="col-lg-12 text-center">
<h2>About</h2>
<hr class="star-primary">
</div>
</div>
<div class="row">
<div class="col-lg-8 col-lg-offset-2">
<p style="text-align: justify">
Augurk is an open-source living documentation system created especially to increase the value of your <a href="https://github.com/cucumber/cucumber/wiki/Gherkin">Gherkin</a> feature files.
For existing feature files, Augurk provides an accessible, easy-to-use overview of all the scenarios describing the features of your application(s).
</p>
<p>
But Augurk does more than just improve the readability of features written in plain Gherkin syntax. Augurk also helps you to enrich your documentation by using features specifically designed to help you bridge the often perceived gap between specification and documentation.
</p>
</div>
<div class="col-xs-6 col-lg-4 col-lg-offset-2 text-right">
<a href="https://github.com/Augurk/Augurk/releases/latest" class="btn btn-lg btn-success btn-outline">
<i class="fa fa-download"></i> Download
</a>
</div>
<div class="col-xs-6 col-lg-4">
<a href="https://github.com/Augurk/Augurk/" class="btn btn-lg btn-success btn-outline">
<i class="fa fa-eye"></i> View Source
</a>
</div>
</div>
</div>
</section>
<!-- Portfolio Grid Section -->
<section class="success" id="portfolio">
<div class="container">
<div class="row">
<div class="col-lg-12 text-center">
<h2>Key Features</h2>
<hr class="star-light">
</div>
</div>
<div class="row">
<div class="col-sm-4 portfolio-item">
<a href="#portfolioModal1" class="portfolio-link" data-toggle="modal">
<div class="caption">
<div class="caption-content">
<i class="fa fa-search-plus fa-3x"></i>
</div>
</div>
<img src="img/features/collapsing-tables.png" class="img-responsive" alt="Gherkin tables can easily be collapsed">
</a>
<br/>
<p class="subtitle">Collapsing tables</p>
</div>
<div class="col-sm-4 portfolio-item">
<a href="#portfolioModal2" class="portfolio-link" data-toggle="modal">
<div class="caption">
<div class="caption-content">
<i class="fa fa-search-plus fa-3x"></i>
</div>
</div>
<img src="img/features/markdown-support.png" class="img-responsive" alt="Markdown embedded in Gherkin feature files are beautifully rendered in Augurk">
</a>
<br/>
<p class="subtitle">Markdown support </p>
</div>
<div class="col-sm-4 portfolio-item">
<a href="#portfolioModal3" class="portfolio-link" data-toggle="modal">
<div class="caption">
<div class="caption-content">
<i class="fa fa-search-plus fa-3x"></i>
</div>
</div>
<img src="img/features/organising.png" class="img-responsive" alt="Organising your Gherkin feature files is really simple with Augurk">
</a>
<br/>
<p class="subtitle">Organising features</p>
</div>
<div class="col-sm-4 portfolio-item">
<a href="#portfolioModal4" class="portfolio-link" data-toggle="modal">
<div class="caption">
<div class="caption-content">
<i class="fa fa-search-plus fa-3x"></i>
</div>
</div>
<img src="img/features/not-implemented-tag.png" class="img-responsive" alt="When doing Specification By Example you might have in progress features.">
</a>
<br/>
<p class="subtitle">Not implemented tag</p>
</div>
<div class="col-sm-4 portfolio-item">
<a href="#portfolioModal5" class="portfolio-link" data-toggle="modal">
<div class="caption">
<div class="caption-content">
<i class="fa fa-search-plus fa-3x"></i>
</div>
</div>
<img src="img/features/product-pages.png" class="img-responsive" alt="Product pages allow you to add additional documentation on top of your SbE scenario's">
</a>
<br/>
<p class="subtitle">Product pages</p>
</div>
<div class="col-sm-4 portfolio-item">
<a href="#portfolioModal6" class="portfolio-link" data-toggle="modal">
<div class="caption">
<div class="caption-content">
<i class="fa fa-search-plus fa-3x"></i>
</div>
</div>
<img src="img/features/coming-soon.png" class="img-responsive" alt="Augurk is open source, so new features can quickly be added">
</a>
<br/>
<p class="subtitle">More coming soon!</p>
</div>
</div>
</div>
</section>
<section id="inspiration">
<div class="container">
<div class="row">
<div class="col-lg-12 text-center">
<h2>Inspiration</h2>
<hr class="star-primary">
</div>
</div>
<div class="row">
<div class="col-lg-8 col-lg-offset-2">
<p style="text-align: justify">
Augurk is greatly influenced by <a href="https://www.relishapp.com/">Relish</a> and <a href="http://www.picklesdoc.com/">Pickles</a>. While Relish is a great SaaS application, it requires you to publish your documentation to the cloud. While this is not an issue when your sources live in the cloud as well, in other cases it is often still preferable to keep the documentation within the corporate intranet. <br/>
This leaves Pickles. Although Pickles adresses the cloud issue (it was designed for that purpose), it has some short-comings of its own. Pickles generates a neat (Dynamic)HTML website for each project/solution you require it to. It does, however, not incorporate these. This means not only will you get a website for each solution, you can multiply your number of websites with the number of branches or products you maintain simultaneously.
</p>
<p style="text-align: justify">
Augurk has been designed to address exactly these issues. It allows you to publish your features from multiple solutions and branches to a single location, providing you with a single access-point for all your documentation. While Augurk is based upon the same principles as Pickles, it has been rebuild completely from the ground-up, allowing Augurk to provide all the same functionality but simultaneously improving and extending it where necessary.
</p>
</div>
</div>
</div>
</section>
<!-- Footer -->
<footer class="text-center">
<div class="footer-above">
<div class="container">
<div class="row">
<div class="footer-col col-md-6">
<h3>Around the Web</h3>
<ul class="list-inline">
<li>
<a href="https://twitter.com/augurkdevs" class="btn-social btn-outline"><i class="fa fa-fw fa-twitter"></i></a>
</li>
<li>
<a href="https://github.com/augurk" class="btn-social btn-outline"><i class="fa fa-fw fa-github"></i></a>
</li>
</ul>
</div>
<div class="footer-col col-md-6">
<h3>About Augurk</h3>
<p>Adding the "living" to your <br/> <a href="https://github.com/cucumber/cucumber/wiki/Gherkin">Gherkin</a>-based documentation.</p>
</div>
</div>
</div>
</div>
<div class="footer-below">
<div class="container">
<div class="row">
<div class="col-lg-12">
Copyright © 2016-2018 Augurk
</div>
</div>
</div>
</div>
</footer>
<!-- Scroll to Top Button (Only visible on small and extra-small screen sizes) -->
<div class="scroll-top page-scroll hidden-sm hidden-xs hidden-lg hidden-md">
<a class="btn btn-primary" href="#page-top">
<i class="fa fa-chevron-up"></i>
</a>
</div>
<!-- Portfolio Modals -->
<div class="portfolio-modal modal fade" id="portfolioModal1" tabindex="-1" role="dialog" aria-hidden="true">
<div class="modal-content">
<div class="close-modal" data-dismiss="modal">
<div class="lr">
<div class="rl">
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-lg-8 col-lg-offset-2">
<div class="modal-body">
<h2>Collapsing tables</h2>
<hr class="star-primary">
<img src="img/features/collapsing-tables-modal.gif" class="img-responsive img-centered" alt="">
<p>
To make long feature files with large tables a bit more easier to read Augurk allows you to collapse
large tables so you can stay focused on the functionality. You can even collapse entire scenarios
so that you can focus on the most important ones.
</p>
<ul class="list-inline item-details">
<li>Since Version:
<strong><a href="https://github.com/Augurk/Augurk/releases/tag/1.0.0">1.0.0</a></strong>
</li>
<li>Date:
<strong>September 2015</strong>
</li>
</ul>
<button type="button" class="btn btn-default" data-dismiss="modal"><i class="fa fa-times"></i> Close</button>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="portfolio-modal modal fade" id="portfolioModal2" tabindex="-1" role="dialog" aria-hidden="true">
<div class="modal-content">
<div class="close-modal" data-dismiss="modal">
<div class="lr">
<div class="rl">
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-lg-8 col-lg-offset-2">
<div class="modal-body">
<h2>Markdown support</h2>
<hr class="star-primary">
<img src="img/features/markdown-support-modal.png" class="img-responsive img-centered" alt="">
<p>
Need a bit more than just flat text for your documentation? No problem, Augurk supports Markdown for
feature and scenario descriptions so you can do things like <b>bold</b> and <i>italic</i> text.
You can even add images for additional understanding.
</p>
<ul class="list-inline item-details">
<li>Since version:
<strong><a href="https://github.com/Augurk/Augurk/releases/tag/1.0.0">1.0.0</a></strong>
</li>
<li>Date:
<strong>September 2015</strong>
</li>
</ul>
<button type="button" class="btn btn-default" data-dismiss="modal"><i class="fa fa-times"></i> Close</button>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="portfolio-modal modal fade" id="portfolioModal3" tabindex="-1" role="dialog" aria-hidden="true">
<div class="modal-content">
<div class="close-modal" data-dismiss="modal">
<div class="lr">
<div class="rl">
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-lg-8 col-lg-offset-2">
<div class="modal-body">
<h2>Organising features</h2>
<hr class="star-primary">
<img src="img/features/organising-modal.gif" class="img-responsive img-centered" alt="">
<p>
When publishing all your feature files to a single location, things tend to get quite messy.
Augurk helps you to prevent this by allowing you to organise your features into products and groups.
In addition, it supports (semantic) versioning so you can view different versions of a particular
feature all in one central location.
</p>
<ul class="list-inline item-details">
<li>Since version:
<strong><a href="https://github.com/Augurk/Augurk/releases/tag/2.0.0">2.0.0</a></strong>
</li>
<li>Date:
<strong>>September 2015</strong>
</li>
</ul>
<button type="button" class="btn btn-default" data-dismiss="modal"><i class="fa fa-times"></i> Close</button>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="portfolio-modal modal fade" id="portfolioModal4" tabindex="-1" role="dialog" aria-hidden="true">
<div class="modal-content">
<div class="close-modal" data-dismiss="modal">
<div class="lr">
<div class="rl">
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-lg-8 col-lg-offset-2">
<div class="modal-body">
<h2>Not implemented tags</h2>
<hr class="star-primary">
<img src="img/features/not-implemented-tag-modal.png" class="img-responsive img-centered" alt="">
<p>
Still working on a particular feature, but it has not yet been fully implemented? Put a
<b>@notImplemented</b> tag on it and Augurk will display a warning to readers that the
feature has not yet been fully implemented, instead of the error that will be displayed
when you only use the ignore tag.
</p>
<ul class="list-inline item-details">
<li>Since version:
<strong><a href="https://github.com/Augurk/Augurk/releases/tag/1.0.0">1.0.0</a></strong>
</li>
<li>Date:
<strong>September 2015</strong>
</li>
</ul>
<button type="button" class="btn btn-default" data-dismiss="modal"><i class="fa fa-times"></i> Close</button>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="portfolio-modal modal fade" id="portfolioModal5" tabindex="-1" role="dialog" aria-hidden="true">
<div class="modal-content">
<div class="close-modal" data-dismiss="modal">
<div class="lr">
<div class="rl">
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-lg-8 col-lg-offset-2">
<div class="modal-body">
<h2>Product pages</h2>
<hr class="star-primary">
<img src="img/features/product-pages.png" class="img-responsive img-centered" alt="">
<p>
Augurk also has support for creating introduction pages for the various products for which you upload feature
files. This allows for the creation of a custom landing page for your products as well as an entry-point for
discovering the features of that product.
</p>
<ul class="list-inline item-details">
<li>Since version:
<strong><a href="https://github.com/Augurk/Augurk/releases/2.4.0">2.4.0</a></strong>
</li>
<li>Date:
<strong>April 2017</strong>
</li>
</ul>
<button type="button" class="btn btn-default" data-dismiss="modal"><i class="fa fa-times"></i> Close</button>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="portfolio-modal modal fade" id="portfolioModal6" tabindex="-1" role="dialog" aria-hidden="true">
<div class="modal-content">
<div class="close-modal" data-dismiss="modal">
<div class="lr">
<div class="rl">
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-lg-8 col-lg-offset-2">
<div class="modal-body">
<h2>More coming soon!</h2>
<hr class="star-primary">
<img src="img/features/coming-soon-modal.png" class="img-responsive img-centered" alt="">
<p>
We are currently ramping up development of Augurk. Keep an eye on this page and our
<a href="https://github.com/Augurk/Augurk/releases">releases</a> page on GitHub. Or get
involved. It's open source after all!
</p>
<ul class="list-inline item-details">
<li>Since version:
<strong><a href="https://github.com/Augurk/Augurk/releases">Coming soon!</a></strong>
</li>
<li>Date:
<strong>TBD</strong>
</li>
</ul>
<button type="button" class="btn btn-default" data-dismiss="modal"><i class="fa fa-times"></i> Close</button>
</div>
</div>
</div>
</div>
</div>
</div>
<!-- jQuery -->
<script src="vendor/jquery/jquery.min.js"></script>
<!-- Bootstrap Core JavaScript -->
<script src="vendor/bootstrap/js/bootstrap.min.js"></script>
<!-- Plugin JavaScript -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-easing/1.3/jquery.easing.min.js"></script>
<!-- Theme JavaScript -->
<script src="js/freelancer.min.js"></script>
</body>
</html>