Skip to content

getconversio/api-docs

Repository files navigation

CM Commerce API Documentation

Deployment

This repository is deployed to Github Pages using Codeship. The Github Page is aliased by the CM Commerce developers sub-domain, which is managed by the CM infrastructure team. In the event it needs to change, the source/CNAME file also needs to be updated to tell Github to accept requests on the new domain.

Local Development

A handy-dandy Dockerfile and Docker Compose file is provided, so just run docker-compose up and then you can see the docs at http://localhost:4567. Editing the .md files under source/ should automatically restart your server.

Now that Slate is all set up your machine, you'll probably want to learn more about editing Slate markdown, or how to publish your docs.