docs_templ.html

<!-- PAGE HEADER -->

<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>