Interbit SDK Documentation

This repo contains documentation for the Interbit SDK.

It is implemented with GitBook, and has source files in Markdown and Asciidoc formats.

Installation

Run the following commands in a terminal window to install the Interbit documentation, and the dependencies required to generate HTML:

1. Clone the repository

   git clone [email protected]:interbit/docs-interbit.git

2. Change the current directory

   cd docs-interbit

3. Install Node.js dependencies

   npm install

4. Install Ruby dependencies

   bundle install

   Note: If you do not have Ruby's Bundler gem installed, bundle install will fail. To install Bundler, run sudo gem install bundler, then re-run bundle install.

Generate HTML

To generate the HTML, run:

_bin/make.sh

OR, if you have make installed:

make

GitBook, by default, generates a static website for the book. Generation depends on fresh copies of several plugins and theme packages, and there is some minor post-generation cleanup required. The _bin/make.sh script performs all of that work for you.

Tests

A number of tests are available to verify various aspects of the documentation, include checks for broken links, image sizes, repeated works, spelling, etc.

To run the tests:

npm run test

OR, if you have make installed:

make test