zapier/mkdocs repository overview

⁠Docker: MkDocs

⁠Setup

This image assumes the following exist in your project:

• ./mkdocs.yml - configuration file for MkDocs⁠
• ./docs/* - Markdown files referenced in the site's nav

⁠Usage

Run the local development server:

docker run -itv $(PWD):/host -p 8000:8000 zapier/mkdocs

Build HTML for upload to S3:

docker run -itv $(PWD):/host -p 8000:8000 zapier/mkdocs mkdocs build

⁠Contributing

To test locally:

make build
make test
make run

Pushed changes are automatically built on Docker Hub⁠.

Images are automatically tagged from GitHub Releases⁠.