Как установить и настроить API документацию на сервере

[TechnoL0g]

Последняя версия документации SmartHoldem API на основе slate доступна по адресу
https://github.com/smartholdem/api-doc

Установка:

1. Установка Ruby

gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB

sudo apt-get install curl
 \curl -sSL https://get.rvm.io -o rvm.sh
 less rvm.sh
 cat rvm.sh | bash -s stable
 source ~/.rvm/scripts/rvm
 rvm install ruby --default

ruby -v

2. Устанавливаем bundler

gem install bundler

3. Установка документации

git clone https://github.com/smartholdem/api-doc.git
cd api-docs

По умолчанию конфиг настроен на порт localhost:4567, если вы хотите изменить порт, отредактируйте конфиг файл

nano config.rb

строка: set :port, 4567

Компилируем

bundle install

Запускаем

bundle exec middleman server

Для тестирования в windows используйте виртуальную машину с vagrant up.

Для редактирования, основной файл source/index.html.md
Дополнительные файлы в source/includes

Для билдов в html, js использовать команду

bundle exec middleman build

после выполнения появится папка build с всеми откомпилированными файлами