-
Notifications
You must be signed in to change notification settings - Fork 31
/
Copy pathdocumentation.html
379 lines (347 loc) · 14.7 KB
/
documentation.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
<!doctype html>
<html lang="en"><head>
<meta charset="utf-8">
<title>Document-Bootstrap</title>
<!-- Mobile viewport optimized -->
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<!-- Mobile Internet Explorer allows us to activate ClearType technology for smoothing fonts for easy reading -->
<meta http-equiv="cleartype" content="on">
<!-- Le styles -->
<link href="css/bootswatch/Cosmo/bootstrap.min.css" rel="stylesheet">
<link href="http://ajax.googleapis.com/ajax/libs/jqueryui/1.8.21/themes/black-tie/jquery-ui.css" rel="stylesheet">
<link href="css/jquery.tocify.css" rel="stylesheet">
<link href="css/prettify.css" rel="stylesheet" type="text/css">
<link href="css/styles.css" rel="stylesheet" type="text/css">
<link href="css/rainbow/themes/tomorrow-night.css" rel="stylesheet" type="text/css">
<link rel="stylesheet" type="text/css" href="css/rainbowlines/theme.css" media="screen" />
<!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<!-- Le fav and touch icons -->
<link href="../assets/ico/favicon.ico" rel="shortcut icon">
<link href="../assets/ico/apple-touch-icon-144-precomposed.png" rel="apple-touch-icon-precomposed" sizes="144x144">
<link href="../assets/ico/apple-touch-icon-114-precomposed.png" rel="apple-touch-icon-precomposed" sizes="114x114">
<link href="../assets/ico/apple-touch-icon-72-precomposed.png" rel="apple-touch-icon-precomposed" sizes="72x72">
<link href="../assets/ico/apple-touch-icon-57-precomposed.png" rel="apple-touch-icon-precomposed">
</head>
<body>
<a id="fork-me" href="#" target="_blank"><img style="border: 0px currentColor; border-image: none; top: 0px; right: 0px; position: fixed; z-index: 999999;" alt="Fork me on GitHub" src="https://s3.amazonaws.com/github/ribbons/forkme_right_white_ffffff.png"></a>
<nav class="navbar navbar-default navbar-fixed-top" role="navigation" style="margin-bottom:120px;">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<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="#">Enter Project Name here</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 class="active"><a href="#">Link</a></li>
<li><a href="#">Link</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="#">Action</a></li>
<li><a href="#">Another action</a></li>
<li><a href="#">Something else here</a></li>
<li class="divider"></li>
<li><a href="#">Separated link</a></li>
<li class="divider"></li>
<li><a href="#">One more separated link</a></li>
</ul>
</li>
</ul>
</div><!-- /.navbar-collapse -->
</nav>
<div class="container-fluid" style="margin-top:50px;">
<div class="row">
<div class="tocify col-sm-3 col-md-3">
<div id="toc">
</div><!--/.well -->
</div><!--/span-->
<div class="col-sm-9 col-md-9">
<div class="jumbotron">
<h1>Enter Project Name Here</h1>
<br><br>
<h2>Description</h2>
<p>Enter Project Repo Description Here</p>
<br>
<p>The project is hosted on <a class="projectLinks" href="#" target="_blank">Github</a> and is available for use under the <a class="projectLinks" href="#" target="_blank">MIT software license</a>. You can report bugs and discuss features on the <a href="#" target="_blank">GitHub issues page</a>, or send tweets to <a href="#" target="_blank">Enter Project Twitter Page Here</a>.
</p>
<p><a class="btn btn-primary btn-lg" href="#" target="_blank">Fork on Github »</a></p>
</div>
<h2>Requirements</h2>
<br>
<p class="well">
Enter Project Requirements Here
</p>
<br>
<h2>Optional Dependencies</h2>
<br>
<p class="well">
Enter Project Optional Dependencies Here
</p>
<br>
<h2>Notable Features</h2>
<br>
<p class="well">
Enter Notable Features Here
</p>
<br>
<h2>Browser Support</h2>
<br>
<p class="well">
Enter Browser Support Here
</p>
<br>
<h2>Getting Started</h2>
<br>
<p><h3><a href="customDownload.html">Custom Download</a></h3><p></p>
<p class="well">
<span class="note"><strong>Note: </strong> All of the plugin files are in the <code>src</code> directory (this includes both the JavaScript and CSS files). If you want to see an example page with all of the files included, look in the <code>demos</code> directory.
</span>
</p>
<h3>C#</h3>
<p></p>
<p class="well note">
C# Code
</p>
<pre>
<code data-language="csharp">
public class BadgeGenerator : IBadgeGenerator
{
private IBadgeStorageService badgeStoreageService;
public BadgeGenerator(IBadgeStorageService service)
{
if (service == null)
{
throw new ArgumentNullException("storage service cannot be null", "service");
}
this.badgeStoreageService = service;
}
}
</code>
</pre>
<h3>CSS</h3>
<p></p>
<p class="well note">
Enter CSS Instructions Here
</p>
<pre>
<code data-language="css">
* Author: @gregfranko
*/
/* The Table of Contents container element */
#toc {
width: 20%;
max-height: 90%;
overflow: auto;
position: fixed;
border: 0px solid #ccc;
webkit-border-radius: 6px;
moz-border-radius: 6px;
border-radius: 6px;
}
/* The Table of Contents is composed of multiple nested unordered lists. These styles remove the default styling of an unordered list because it is ugly. */
#toc ul, #toc li {
list-style: none;
margin: 0;
padding: 0;
border: none;
line-height: 30px;
}
</code>
</pre>
<p>
<h3>JavaScript</h3>
<p></p>
<p class="well note">
Enter JavaScript Instructions Here
</p>
<pre>
<code data-language="javascript">
;(function () {
var
object = typeof window != 'undefined' ? window : exports,
chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=',
INVALID_CHARACTER_ERR = (function () {
// fabricate a suitable error object
try { document.createElement('$'); }
catch (error) { return error; }}());
// encoder
// [https://gist.github.com/999166] by [https://github.com/nignag]
object.btoa || (
object.btoa = function (input) {
for (
// initialize result and counter
var block, charCode, idx = 0, map = chars, output = '';
// if the next input index does not exist:
// change the mapping table to "="
// check if d has no fractional digits
input.charAt(idx | 0) || (map = '=', idx % 1);
// "8 - idx % 1 * 8" generates the sequence 2, 4, 6, 8
output += map.charAt(63 & block >> 8 - idx % 1 * 8)
) {
charCode = input.charCodeAt(idx += 3/4);
if (charCode > 0xFF) throw INVALID_CHARACTER_ERR;
block = block << 8 | charCode;
}
return output;
});
// decoder
// [https://gist.github.com/1020396] by [https://github.com/atk]
object.atob || (
object.atob = function (input) {
input = input.replace(/=+$/, '')
if (input.length % 4 == 1) throw INVALID_CHARACTER_ERR;
for (
// initialize result and counters
var bc = 0, bs, buffer, idx = 0, output = '';
// get next character
buffer = input.charAt(idx++);
// character found in table? initialize bit storage and add its ascii value;
~buffer && (bs = bc % 4 ? bs * 64 + buffer : buffer,
// and if not first of each 4 characters,
// convert the first 8 bits to one ascii character
bc++ % 4) ? output += String.fromCharCode(255 & bs >> (-2 * bc & 6)) : 0
) {
// try to find character in table (0-63, not found => -1)
buffer = chars.indexOf(buffer);
}
return output;
});
}());
</code>
</pre>
<h2>Options</h2>
<p class="well note">
Enter Options Instructions Here
</p>
<h3>Options</h3>
<table class="table table-striped table-bordered table-condensed">
<tbody><tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th>Parameters</th>
</tr>
<tr>
<td title="Option Name" class="optionName" data-content="Enter Option Description Here">
<a href="#">Option Name</a>
</td>
<td>Enter Option Type Here</td>
<td>Enter Option Default Here</td>
<td>Enter Option Parameters Here</td>
</tr>
<tr>
<td title="Option Name" class="optionName" data-content="Enter Option Description Here">
<a href="#">Option Name</a>
</td>
<td>Enter Option Type Here</td>
<td>Enter Option Default Here</td>
<td>Enter Option Parameters Here</td>
</tr>
<tr>
<td title="Option Name" class="optionName" data-content="Enter Option Description Here">
<a href="#">Option Name</a>
</td>
<td>Enter Option Type Here</td>
<td>Enter Option Default Here</td>
<td>Enter Option Parameters Here</td>
</tr>
<tr>
<td title="Option Name" class="optionName" data-content="Enter Option Description Here">
<a href="#">Option Name</a>
</td>
<td>Enter Option Type Here</td>
<td>Enter Option Default Here</td>
<td>Enter Option Parameters Here</td>
</tr>
<tr>
<td title="Option Name" class="optionName" data-content="Enter Option Description Here">
<a href="#">Option Name</a>
</td>
<td>Enter Option Type Here</td>
<td>Enter Option Default Here</td>
<td>Enter Option Parameters Here</td>
</tr>
<tr>
<td title="Option Name" class="optionName" data-content="Enter Option Description Here">
<a href="#">Option Name</a>
</td>
<td>Enter Option Type Here</td>
<td>Enter Option Default Here</td>
<td>Enter Option Parameters Here</td>
</tr>
<tr>
<td title="Option Name" class="optionName" data-content="Enter Option Description Here">
<a href="#">Option Name</a>
</td>
<td>Enter Option Type Here</td>
<td>Enter Option Default Here</td>
<td>Enter Option Parameters Here</td>
</tr>
<tr>
<td title="Option Name" class="optionName" data-content="Enter Option Description Here">
<a href="#">Option Name</a>
</td>
<td>Enter Option Type Here</td>
<td>Enter Option Default Here</td>
<td>Enter Option Parameters Here</td>
</tr>
</tbody></table>
<br>
<h2>Contributing</h2>
<p class="well">
Take care to maintain the existing coding style. Add <strong>Enter Unit Testing Framework</strong> unit tests for any new or changed functionality. Lint and test your code using <strong>Enter Build Tool Here</strong>.
</p>
<p class="well">
<span class="note">
After you have verified your code, send a pull request to the <em>Enter Project Name Here</em> develop branch. After you send a pull request, you will hear back from me shortly after I review your code. You’ll find source code in the <code>src</code> subdirectory!
</span>
</p>
<br>
<h2>Extending</h2>
<p class="well">
If you find that you need a feature that <em>Enter Project Name Here</em> does not currently support, either let me know via the <a href="#" target="_blank">Github issue tracker</a>, or <a href="#" target="_blank">fork the project</a> and and easily extend <em>Enter Project Name Here</em>!
</p>
<br>
<h2>Copyright</h2>
<p class="well">
Copyright © 2013 Enter Author Name Here
</p>
</div>
</div><!--/row-->
</div><!--/.fluid-container-->
<!-- Le javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
<script src="js/rainbow/rainbow.min.js"></script>
<script src="js/rainbow/language/generic.js"></script>
<script src="js/rainbow/language/html.js"></script>
<script src="js/rainbow/language/css.js"></script>
<script src="js/rainbow/language/javascript.js"></script>
<script src="js/rainbowlines/rainbow.linenumbers.js"></script>
<script src="js/jquery.min.js"></script>
<script src="js/jquery-ui.min.js"></script>
<script src="js/bootstrap.min.js"></script>
<script src="js/jquery.tocify.min.js"></script>
<script src="js/prettify.js"></script>
<script>
$(function() {
$("#toc").tocify({ selectors: "h2, h3, h4", scrollTo: 60, highlightOffset: 60, extendPage: true });
prettyPrint();
$(".optionName").popover({ trigger: "hover", container: "body" });
$("a[href='#']").click(function(event) {
event.preventDefault();
});
Rainbow.color();
});
</script>
</div></body></html>