-
Notifications
You must be signed in to change notification settings - Fork 12
/
index.html
112 lines (112 loc) · 5.22 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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Javadoc to Markdown</title>
<meta name="description" content="Generate Markdown from your Javadoc, PHPDoc or JSDoc comments. Convert your comments from code into a well-written documentation with just one click.">
<link href="_css/bootstrap.min.css" rel="stylesheet">
<link href="_css/bootstrap-theme.min.css" rel="stylesheet">
<link href="_css/custom.css" rel="stylesheet">
<script src="_js/ie10-viewport-bug-workaround.js"></script>
<!--[if lt IE 9]>
<script src="_js/html5shiv.min.js"></script>
<script src="_js/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="container">
<div class="header">
<ul class="nav nav-pills pull-right">
<li class="active"><a href="index.html">Converter</a></li>
<li><a href="https://github.com/delight-im/Javadoc-to-Markdown">Source</a></li>
<li><a href="https://github.com/delight-im/Javadoc-to-Markdown/issues">Issues</a></li>
</ul>
<h3 class="text-muted">Javadoc to Markdown</h3>
</div>
<div class="jumbotron">
<h1>Javadoc to Markdown</h1>
<p class="lead">Just paste your code containing one or more comments in Javadoc, PHPDoc or JSDoc format.</p>
<p>The converter will generate a Markdown version on the client-side.</p>
<p><a class="btn btn-lg btn-success" href="#" role="button" id="btn-start">Start now</a></p>
</div>
<div class="row">
<div class="col-lg-12">
<form class="form-horizontal" role="form" id="javadoc-to-markdown-form">
<div class="form-group">
<label for="javadoc-to-markdown-language" class="col-sm-2 control-label">Language</label>
<div class="col-sm-10">
<select class="form-control" name="javadoc-to-markdown-language" id="javadoc-to-markdown-language">
<option value="Javadoc">Java / Android (Beta)</option>
<option value="PHPDoc">PHP (Beta)</option>
<option value="JSDoc">JavaScript (Beta)</option>
</select>
<p class="help-block">Your language isn't supported yet? Help us on <a href="https://github.com/delight-im/Javadoc-to-Markdown">GitHub</a> or use the default for now.</p>
</div>
</div>
<div class="form-group" id="hidden-options" style="display:none;">
<label for="javadoc-to-markdown-headings" class="col-sm-2 control-label">Headings</label>
<div class="col-sm-10">
<select class="form-control" name="javadoc-to-markdown-headings" id="javadoc-to-markdown-headings">
<option value="1">First level — h1</option>
<option value="2">Second level — h2</option>
<option value="3">Third level — h3</option>
<option value="4">Fourth level — h4</option>
<option value="5">Fifth level — h5</option>
<option value="6">Sixth level — h6</option>
</select>
<p class="help-block">What base level do you want the docs' headings to have?</p>
</div>
</div>
<div class="form-group">
<label for="javadoc-to-markdown-code" class="col-sm-2 control-label">Javadoc</label>
<div class="col-sm-10">
<textarea class="form-control expand" rows="5" placeholder="Paste your code that contains Javadoc ..." name="javadoc-to-markdown-code" id="javadoc-to-markdown-code"></textarea>
<p class="help-block">Your code won't be saved — it's processed on the client-side only. You may run this offline.</p>
</div>
</div>
<div class="form-group">
<div class="col-sm-offset-2 col-sm-10">
<button type="submit" class="btn btn-primary">Convert to Markdown</button>
<a href="#" class="btn btn-default" id="btn-options">More options</a>
</div>
</div>
</form>
</div>
</div>
<div class="col-lg-12" style="display:none;">
<h2>Results <small><a href="#" id="btn-select-all">(Select all)</a></small></h2>
<pre id="results"></pre>
</div>
<div class="row marketing">
<div class="col-lg-12">
<h2>About "Javadoc to Markdown"</h2>
</div>
<div class="col-lg-6">
<h4>Simple</h4>
<p>488 lines of well-documented code is all you need to convert your Javadoc to Markdown.</p>
<h4>Flexible</h4>
<p>You can convert not only from Javadoc but also from PHPDoc, JSDoc etc. using this library.</p>
<h4>Open source</h4>
<p>"Javadoc to Markdown" is available under the terms of the Apache License 2.0 for your use.</p>
</div>
<div class="col-lg-6">
<h4>Portable</h4>
<p>Use the converter on any device with a modern web browser or call it from your Node.js tools.</p>
<h4>Lightweight</h4>
<p><code>javadoc-to-markdown.js</code>, which does the conversion, is only 5.5 KB compressed.</p>
<h4>Community</h4>
<p>We welcome all contributions, whether these are questions, issues, code fixes or improvements.</p>
</div>
</div>
<div class="footer">
<p>© <a href="http://www.delight.im/">delight.im</a> — <a rel="nofollow" href="https://www.delight.im/contact">Contact</a> · <a href="https://github.com/delight-im">GitHub</a></p>
</div>
</div>
<script src="_js/jquery.min.js"></script>
<script src="_js/bootstrap.min.js"></script>
<script src="_js/javadoc-to-markdown.js"></script>
<script src="_js/custom.js"></script>
</body>
</html>