= Gravitee.io - Documentation

ifdef::env-github[] :warning-caption: :warning: endif::[]

WARNING: THIS DOCUMENTATION APPLIES TO GRAVITEE VERSIONS RELEASED PRIOR TO 4.0. FOR GRAVITEE 4.0 DOCUMENTATION, CLICK https://github.com/gravitee-io/gravitee-platform-docs[HERE].

== How to write documentation for Gravitee.io

Our documentation website is generated from AsciiDoc files. + You'll find these pages under the /pages directory.

=== Live Preview

We suggest you to use a live preview utility like the one available with jekyll.

First, you need to install:

• Ruby: https://www.ruby-lang.org/en
• Bundler: run the following command line in your favorite terminal gem install bundler

Then, you will be able to install required dependencies and start the documentation: [source,bash]

Install dependencies

bundle install

Build and start the documentation locally

bundle exec jekyll serve --incremental

Go to http://127.0.0.1:4000 to see your modifications.

For contributions guidelines, please refer to CONTRIBUTING.adoc