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

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

Manually

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

Making changes

Edit the source/openapi3/split.yaml or any themes/templates. The preview should update a few seconds after you save your changes.
Changes to the YAML file will be built and output to the source/ directory, so don't edit the build output in there.
Update the Changelog section of source/openapi3/split.yaml.
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.

License

zeptofs/nz-api-documentation

ErrorLooks like something went wrong!

About

Resources

License

Code of conduct

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors 141

Uh oh!

Languages

Error
Looks like something went wrong!

Packages