skeddly-api-docs
This repo contains the source files for the Skeddly API documentation.
The documentation is in Swagger format.
Requirements
- The build and deploy scripts uses PowerShell.
- Building of static HTML files uses swagger-codegen.
Building
- Setup the build environment by executing
build-init.ps1.
ps> .\build-init.ps1
- Build the HTML files by executing
build.ps1.
ps> .\build.ps1
Deploying
The built files are deployed to http://docs.skeddly.com/. Use deploy.ps1
to deploy the generated files.
ps> .\deploy.ps1