Files

The actual documentation files live in the /source/includes directory.

Running Slate

If you wish to run the development server for Slate to aid in working on the site, run:

docker run --rm --name slate -p 4567:4567 -v $(pwd)/source:/srv/slate/source slatedocs/slate serve

and you will be able to access your site at http://localhost:4567 until you stop the running container process.

Deployment Process

First, run this command to build the docs:

docker run --rm --name slate -v $(pwd)/build:/srv/slate/build -v $(pwd)/source:/srv/slate/source slatedocs/slate

Then, run this command to deploy them:

./deploy.sh --push-only

Without the --push-only option the deploy script tries to build the site first, which would require you to install a number of dependencies, which the docker command above made unnecessary.

References:

• https://hub.docker.com/r/slatedocs/slate
• https://github.com/slatedocs/slate/wiki/Deploying-Slate