Documentation GeneratorIntroduction

LucyBot's Documentation Generator uses open standards like Markdown and OpenAPI (or RAML/WADL/etc.) to create a fully customizable website. Learn more about LucyBot's tools at lucybot.com.

Getting Started

You can try the starter version of LucyBot on GitHub.

The rest of this documentation applies only to the full version - visit lucybot.com for access.

Installation

You'll need the latest versions of NodeJS (6.x) and npm

Upon purchase, you'll be given an access key that allows you to install the latest version of LucyBot:

npm install -g https://$YOUR_ACCESS_KEY@github.com/LucyBot-Inc/documentation-generator#v3.16.0
lucybot --version

Setup

Create a new directory to hold your LucyBot configuration and any API specifications, Markdown files, HTML assets, etc:

mkdir acme_docs
touch acme_docs/LucyBot.yml

Examples

• LucyBot docs - The repository that drives the documentation seen here
• Kaltura Developer Platform - For Kaltura's VPaaS documentation
• AnyAPI - Documentation for 300+ APIs