Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

designmynight/collins-api-docs

Open more actions menu

Repository files navigation

Collins API Documentation

This repository contains the documentation for the Collins API.

Viewing the docs

You can find the docs using the following URL: https://docs.collinsbookings.com

Developing locally

To make local changes to the documentation, first clone the repository.

$ git clone https://github.com/designmynight/collins-api-docs
$ cd collins-api-docs

You can use Docker to host a local development environment of the documentation.

$ docker-compose up

The documentation will be served on localhost at port 8080 - http://localhost:8080

Publishing

Publishing the docs

The latest docs are generated on a push to master

Publishing the SDK

On commit to master SDK is automatically published to NPM: https://www.npmjs.com/package/collins-js-sdk. you must increment the version in package.json otherwise the package will not be replaced.

About

📕 Documentation for the Collins API

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 7

Morty Proxy This is a proxified and sanitized view of the page, visit original site.