forked from vert-x/vert-x.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdocs.html
162 lines (133 loc) · 6.08 KB
/
docs.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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<link href='http://fonts.googleapis.com/css?family=Lato' rel='stylesheet' type='text/css'>
<!-- <link rel="stylesheet/less" href="bootstrap/less/bootstrap.less">
<script src="bootstrap/less/less-1.3.3.min.js"></script>
-->
<link href="bootstrap/bootstrap.css" type="text/css" rel="stylesheet"/>
<link href="google-code-prettify/prettify.css" type="text/css" rel="stylesheet"/>
<script type="text/javascript" src="google-code-prettify/prettify.js"></script>
<link href="css/vertx.css" type="text/css" rel="stylesheet"/>
<link href="css/sunburst.css" type="text/css" rel="stylesheet"/>
<title>Vert.x</title>
<script>
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-30144458-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body onload="prettyPrint()" class="hp">
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse"
data-target=".nav-collapse">
<span class="i-bar"></span>
<span class="i-bar"></span>
<span class="i-bar"></span>
</a>
<a class="brand" href="/">Vert.x</a>
<div class="nav-collapse">
<ul class="nav">
<li><a href="/">Home</a></li>
<li><a href="downloads.html">Download</a></li>
<li><a href="install.html">Install</a></li>
<li><a href="docs.html">Documentation</a></li>
<li><a href="examples.html">Examples</a></li>
<li><a href="community.html">Project Info</a></li>
<li><a href="https://github.com/vert-x/vert.x">Github</a></li>
<li><a href="http://modulereg.vertx.io/">Module Registry</a></li>
<li><a href="http://groups.google.com/group/vertx">Google Group</a></li>
<li><a href="http://vertxproject.wordpress.com/">Blog</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="span12">
<div class="well">
<h1>Documentation</h1>
</div>
</div>
</div>
<div class="row">
<div class="span12">
<div class="well">
<p>The Vert.x documentation is organised into a few different
manuals.</p>
<h2>Installation</h2>
<p>
Get Vert.x installed and execute your first <b>Hello World</b> Vert.x example with the <a href="install.html">installation guide</a>.
</p>
<h2>Core Concepts</h2>
<p>
The <a href="manual.html">main manual</a>
contains an introduction to Vert.x and deals with
general concepts. It's highly recommended you read this so you get a good overview of what Vert.x is useful for and how it works.
</p>
<h2>Modules</h2>
<p>
Modules are a core feature of Vert.x which you'll need to understand to write effective Vert.x applications.
The <a href="mods_manual.html">modules manual</a> tells you everything you need to know about using and creating
Vert.x modules.
</p>
<h2>Reference</h2>
<p>
We provide an in-depth API reference manual that describes how to use the Vert.x to do most things.
</p>
<p>There's a different version of the API manual for each officially supported language.</p>
<p>We also provide generated API documentation (e.g. JavaDoc, GroovyDoc etc) for each API</p>
<ul>
<li>
Java <a href="core_manual_java.html">manual</a> | <a href="api/java/index.html">JavaDoc</a>
</li>
<li>
JavaScript <a href="core_manual_js.html">manual</a> | <a href="mod-lang-js/docs/1.0.0/index.html">JSDoc</a>
</li>
<li>
Ruby <a href="core_manual_ruby.html">manual</a> | <a href="api/ruby/index.html">Yardoc</a>
</li>
<li>
Python <a href="core_manual_python.html">manual</a> | <a href="api/epydoc/index.html">epydoc</a> | <a href="api/pydoc/index.html">pydoc</a>
</li>
<li>
Groovy <a href="core_manual_groovy.html">manual</a> | <a href="api/groovy/index.html">GroovyDoc</a>
</li>
<li>
Clojure <a href="core_manual_clojure.html">manual</a> | <a href="api/clojure/index.html">Codox Docs</a>
</li>
<li>
Scala <a href="core_manual_scala.html">manual</a> | <a href="api/scala/index.html">ScalaDoc</a>
</li>
</ul>
<h2>Documentation Library</h2>
<p>Here's a library of other useful docs</p>
<ul>
<li>Get started <a href="maven_dev.html">developing Vert.x applications with Maven</a></li>
<li>Get started <a href="gradle_dev.html">develop Vert.x applications with Gradle</a></li>
<li>Learn how to <a href="dev_guide.html">develop Vert.x applications</a> with the standard project layout.</li>
<li>Learn how to <a href="embedding_manual.html">embed Vert.x</a> in a Java (or Groovy) application.</li>
<li>Learn how to implement <a href="language_support.html">new language support</a> in Vert.x.</li>
</ul>
<p>Some other Vert.x resources</p>
<ul>
<li>Some <a href="https://github.com/eclipse/vert.x/wiki/Vert.x-Media-Articles">media articles</a> about Vert.x</li>
<li>Some <a href="https://github.com/vert-x/vert.x/wiki/Vert.x-Presentations">presentations</a> about Vert.x</li>
</ul>
<h3>Documentation for older Vert.x versions:</h3>
<p>Documentation for <a href="https://github.com/eclipse/vert.x/tree/gh-pages/docs_md">Vert.x 1.3.1-final</a></p>
</div>
</div>
</div>
</div>
</body>
</html>