OrientDB Documentation

Welcome to OrientDB - the first Multi-Model Open Source NoSQL DBMS that brings together the power of graphs and the flexibility of documents into one scalable high-performance operational database.

image

Documentation Builds

Building the OrientDB Documentation website and PDF requires that you install Git, Node.js and GitBook on your system. While you can install Git and Node.js through your package manager, GitBook requires npm, the Node.js package manager tool. Be sure that you install GitBook in global mode:

  1. $ sudo npm install gitbook-cli -g

The documentation builds are managed through make. The packaged Makefile has the following build targets:

  • create: Builds the documentation website at ./deploy/latest.
  • pdf: Builds the documentation PDF at ./deploy/pdf.
  • install: Installs GitBook plugins needed for build.
  • clean: Removes content from ./deploy/latest.
  • pull: Pulls down latest documentation source files from GitHub.
  • all: Runs website and PDF builds.

Rules and Code Conventions

In order for GitBook to properly format and process links, (and to ensure that it throws the appropriate warnings in the event of errors), you MUST use the following format:

  • Internal Links to Docs Page: [Title](filename.md)
  • Internal Link to Chapter: [Title](filename.md#chapter_heading)
  • External Links: [Title](http://example.com)

Warning Boxes

GitBook does not include admonition boxes by default. Use the following format to create them:

  1. | | |
  2. |----|-----|
  3. |![](images/warning.png)|YOUR MESSAGE|