Skip to content

Beautiful static documentation for your API

License

Notifications You must be signed in to change notification settings

Zegocover/documentation

 
 

Repository files navigation

Zego API documentation (Slate)

Prerequisites

You're going to need:

  • Linux or OS X — Windows may work, but is unsupported.
  • Ruby, version 2.3.1 or newer
  • Bundler
  • node

Local Setup and Deploy


git clone git@github.com:Zegocover/documentation.git
cd documentation
make build-image
make run

# Update files in ./source to make your changes
vim source/index.html.md


# Deploy
eval $(zego-aws-login zego-production developer)
make deploy

About

Beautiful static documentation for your API

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 88.6%
  • CSS 7.1%
  • Ruby 1.6%
  • Shell 1.5%
  • HTML 1.0%
  • Makefile 0.1%
  • Dockerfile 0.1%