Zepto API Documentation

Welcome to the NZ Zepto API documentation source.

How does it work?

• The Zepto API is documented using the OpenAPI 3.0.0 specification.
• The new Swagger editor was used to get the boilerplate done.
• The API spec is then converted to Slate friendly markdown with Widdershins.

Get started

Using Docker

1. Clone the repo
2. Make sure you have Docker installed
3. Run $ docker-compose build
4. Once the previous step is completed, run $ docker-compose up
5. Open http://localhost:4567 in your browser to preview the documentation

Manually

1. Clone the repo
2. $ bundle install
3. $ yarn install
4. $ bundle exec foreman start
5. Browse to http://localhost:4567 to preview the documentation.

Making changes

1. Edit the source/openapi3/split.yaml or any themes/templates. The preview should update a few seconds after you save your changes.
2. Changes to the YAML file will be built and output to the source/ directory, so don't edit the build output in there.
3. Update the Changelog section of source/openapi3/split.yaml.
4. Commit both the YAML and the build output changes.

Note: Currently only changes to split.yaml will trigger the automatic update see Guardfile.

Publishing changes

Warning: this script will push changes directly to Github pages. They will be publicly visible. You should only run this after your changes have been reviewed and merged.

$ ./deploy.sh

Notes

• The Slate template/theme is mildly edited to suit our style.
• The same goes for Widdershin's conversion templates.