VMX Documentation Generator

Here you will find documentation in Markdown format and some scripts to build the VMX documentation and push it to https://docs.vision.ai.

compiling docs (on local machine)

Compilation uses http://www.mkdocs.org/ to generate a static site.

./compile.sh

If you don't want to embed Google Analytics code and build a tarball suitable for VMX standalone releases, run:

./compile_local.sh

This will generate a "site/" folder which can be bundled and sent off to the documentation server.

seeing changes to docs live (on local machine)

./serve.sh

This will broadcast the docs on the local network, so that they can be viewed on iOS/Android devices.

deploying docs (from local to docs.vision.ai)

This will send off the documentation to docs.vision.ai

./upload.sh

building standalone docs (to be bundled inside VMX)

./upload_local.sh

running nginx to serve the docs

This requires a checkout of this directory on the docs file server

./server/start_nginx_docker.sh

NOTE: if you are serving over https, you'll need something like nginx-proxy from jwilder and your own SSL certs. If you are a vision.ai admin, use nginx-ssl-proxy.