Skip to content
This repository has been archived by the owner on Jul 12, 2020. It is now read-only.

bookingexperts/bookingexperts_api_v3

 
 

Repository files navigation

Booking Experts API docs

This project creates the documentation of the Booking Experts Open Api 3 specification.

Guide on maintainance

  1. How to run the project in development?

Setup your environment.

bundle install
npm install
bundle exec middleman server
  1. The API changed, what to do?

Builds new docs based on the live oas3.json endpoint.

node oas3_to_markdown.js

A new version of source/index.html.md will be created.

Don't forget to describe the change in our Release Notes by editing the source/includes/_release_notes.md.

  1. How to deploy?

The project is hosted through Github Pages.

Deploys to Github Pages.

git commit -m "<describe change>"
git push
./deploy.sh

About

Beautiful static documentation for your API

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 86.9%
  • CSS 8.5%
  • Ruby 1.9%
  • Shell 1.6%
  • Other 1.1%