This repository has been archived by the owner. It is now read-only.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
source/images
.gitignore
Makefile
README.md
_BlueprintAPI.md
_BlueprintLibrary.md
_BlueprintWritersGuide.md
_CloudProviders.md
_Dev.md
_FAQ.md
_Feedback.md
_HowKeldaWorks.md
_HowTo.md
_Introduction.md
_KeldaCLI.md
_QuickStart.md
_Security.md
index.html.md

README.md

Kelda Documentation

The Kelda documentation is located at docs.kelda.io. This directory contains the Markdown files that are used to generate those docs. We do not recommend directly browing the Markdown files, because the links are designed to work properly for the HTML version of the page, and will not work correctly in the Markdown version.

If you're a developer and you'd like to build the docs, run make in this directory:

$ make

This command will clone two other repositories into the build folder: one with our JSDoc template, which helps to compile the JSDoc in the Kelda JavaScript into HTML; and a second with Slate, which combines the Markdown files here and the JSDoc HTML into a single HTML page. Slate requires Ruby and bundler, so you will need to install those if you don't already have them; e.g., using Homebrew:

$ brew install ruby
$ gem install bundler # gem is Ruby's equivalent of make.

For more information about Slate and its dependencies, refer to the our Slate fork.